cxref - Bulutta Çevrimiçi

Program:

ADI

cxref - C Çapraz Referanslama ve Belgeleme aracı.

SİNOPSİS

cxref Dosya [ ... dosya adı] [-Ödizinadı] [-Nbaz adı] [-Rbaz adı] [-Tüm yorumlar]
[-yorum yok] [-verbatim-yorumlar] [-blok-yorumlar]
[-xref[-all][-dosya][-fonk][-var][-tip]] [-uyar[-tümü][-yorum][-xref]]
[-index[-all][-file][-func][-var][-type]] [-çiğ] [-lateks] [-html[-src]] [-rtf] [-sgml]
[-BENdizinadı] [-NStanımlamak] [-Utanımlamak] [-CPP cpp_programı] [-- cpp_args ... cpp_args]

cxref Dosya [ ... dosya adı] -sil [-Ödizinadı] [-Nbaz adı] [-Rbaz adı]

TANIM

Bir C için otomatik olarak belgeler ve çapraz referanslar oluşturabilen bir program
programı.

Girdi, uygun yorumlara sahip herhangi bir C programıdır ve çıktı, LaTeX, HTML, RTF veya
SGML dosyaları.

SEÇENEKLER

Dosya
Belgelenecek dosyanın adı, aynı anda herhangi bir sayıda dosya belgelenebilir.

-sil
Adlandırılmış dosyalar, çıktı dizininden ve giriş dizininden silinecektir.
çapraz referans veritabanı ve ana çıktı dosyaları kaldırılacaktır.

-Odirname
Çıktı lateks dosyaları için kullanılacak bir dizinin adı ve
oluşturulan çapraz referans dosyaları.

-Ntemel adı
Çıktının ilk bölümü için kullanılacak ad ve bunun yerine çapraz referans dosyaları
cxref'in dosya uzantıları aynı kalır.

-Rdirname
Kaynak dosyalar birden fazla dizinde olduğunda, dirname'yi dizinin adına ayarlayın.
kaynak ağacın kök dizini (daha kolaysa göreli yolu kullanın, örneğin `-R../ ..').
Bu daha sonra bu kök dizinden cxref'i çalıştıracak ve `-Odirname' olmalıdır.
bu dizine göre.

-Tüm yorumlar
Mevcut yorumların işe yarayabileceğini düşünüyorsanız, (açıklama için yukarıya bakın)
özel yorumlar). [Tehlike! Bu seçenek garip sonuçlar doğurabilir.]

-yorum yok
Tüm yorumları yok sayar, yalnızca çapraz referansları istiyorsanız yararlıdır.
dokümantasyon.

-verbatim-yorumlar
Kodda sahip olduğunuz yorumlar önceden belirlenmiş bir tarzda formatlandığında
çıktıda korumak istediğiniz, bu seçenek onları olmamaya zorlayacaktır.
yeniden biçimlendirilmiş. [Not, bu yalnızca dosya ve işlev yorumları içindir.]

-blok-yorumlar
Programdaki yorumlar 'blok' stilinde biçimlendirildiğinde (başında bir
'*' karakteri), bu seçenek o karakteri
çıktı. [Tek bir `*', `+', `|' için çalışır veya her satırda `:'.]

-xref Çapraz referans bilgileri üretin (aşağıya bakın).
-all Tüm çapraz referanslar.
-file Dosyalar için çapraz referanslar.
-func Fonksiyonlar için çapraz referanslar.
-var Değişkenler için çapraz referanslar.
-type Türler için çapraz referanslar.

-uyarmak Uyarı üretin, seçenekler bir araya getirilmelidir:
-tüm Tüm uyarılar.
-yorum Eksik yorumlar konusunda uyarın.
-xref Eksik çapraz referanslara karşı uyarır.

dizin Bir çapraz referans indeksi üretin, seçenekler bir araya getirilmelidir:
-tüm Tüm dizinler.
-file Dosya dizini.
-func Fonksiyon indeksi.
-var Değişken dizini.
-type Tür dizini.

-çiğ -warn dışında pek kullanılmayan, ham bir çıktı biçimi üretin.

-lateks Kaynak dosyaların her birini ve ayrıca ekstra bir dosyayı belgelemek için bir LaTeX dosyası oluşturun
bu dosyaların her birini içerir.

-html Kaynak dosyaların her birini belgelemek için bir HTML 4.01 dosyası ve bir ana dosya oluşturun.
bu dosyaların her birine başvurun.

-html-kaynağı
Kaynak dosyanın HTML çıktısını ve içine bağlantılar içeren bir HTML sürümünü üretin.

-rtf Kaynak dosyayı belgelemek için bir Zengin Metin Biçimi (RTF) dosyası oluşturun.

-sgml Kaynak dosyayı belgelemek için bir SGML dosyası oluşturun. (LinuxDoc DTD'yi kullanarak).

-İdirname
Dahil edilen dosyaların yolunu belirtmek için GCC seçeneği.

-Dtanımla
Bir ön işlemci sembolü tanımlamak için GCC seçeneği.

-Udefine
Bir ön işlemci sembolünün tanımını kaldırmak için GCC seçeneği.

-CPP program
Derleme zamanı varsayılanı yerine kullanılacak programın adı. program
gcc -E -C -dD'nin çalışması için yaptığı tüm eylemleri gerçekleştirebilmelidir. Eğer
program argümanları alır, sonra her şeyin tırnak içinde olması gerekir, böylece
cxref için tek bir argüman olarak yorumlanır.

--arg ... arg
Ön işlemciye iletilecek ekstra argümanlar `--' işaretinden sonra yerleştirilebilir.
ayırıcı.

C derleyici Değiştirme cxref-cc
Mevcut kaynak kodunda cxref kullanımını basitleştirmek için artık bir kabuk betiği var.
C derleyicisini arayın ve ardından kaynak dosyayı işlemek için cxref'i arayın. Bu demektir ki
Makefiles ve benzerlerinde CC'nin yerine bir damla olarak kullanılabilir.

Kullanım: cxref-cc [genel cc seçenekleri]

Kaynak dosyanın adı, seçenekler listesinden ve `-D*'den çıkarılır.
`-I*', `-U*' bayrakları ve C derleyicisi başarılı bir şekilde çıktığında cxref çağrılır. NS
Kullanılacak C derleyicisinin adı, CXREFCC ortam değişkeni tarafından kontrol ediliyorsa veya
bu, CC ortam değişkeni olarak ayarlanmaz veya bu yalnızca gcc'de başarısız olur.

Bu komut dosyasının kullanılması, seçenekleri içermesi için bir ".cxref" yapılandırma dosyasının kullanılmasını gerektirir.
çünkü seçenekleri C derleyicisi için komut satırına koyacak hiçbir yer yoktur.

Bu, yalnızca C kaynak dosyalarını çapraz referans alacak ve belgeleyecektir, çünkü bunlar yalnızca C kaynak dosyalarıdır.
derlenir, ancak bunların çapraz referanslı olduklarından emin olur.
doğru seçenekler vb.

Cxref yapılandırma fileto
Bu komut satırı argümanları, aynı zamanda ".cxref" adlı bir dosyaya da yerleştirilebilir.
Komut satırı. cxref çalıştırıldığında, programın argümanları şu şekilde yorumlanır:
aşağıdaki sıra.

(1) Komut satırındakiler. (2) Geçerli dizindeki `.cxref' dosyasındakiler.
(3) '-R' ile belirtilen kaynak ağaç kökündeki '.cxref' dosyasındakiler.

Bu, çok dizinli bir kaynak ağacında, her alt dizinin bir ".cxref"e sahip olabileceği anlamına gelir.
sadece `-R..' satırını içeren dosya veya uygun. Ana dizinde bir
Seçeneklerin geri kalanını içeren `.cxref' dosyası. Bu ihtiyacı tamamen ortadan kaldırır.
kaynak dosya adları dışında komut satırında herhangi bir seçeneğe sahip olmak.

'.cxref' dosyasının formatı, her biri tek bir satır içeren herhangi bir sayıda satırdır.
komut satırı bağımsız değişkeni (argv'lerden birine eşdeğer). Olmayacak tek seçenek
kullanılanlar, kaynak dosyaların isimleri ve '-delete' seçeneğidir. Boş satırlar
yok sayılır ve '#' ile başlayan satırlar yorumlardır.

Programı belgeleme Yorumlar
Programın belgeleri, koddaki yorumlardan üretilir.
uygun şekilde biçimlendirilmiş. Çapraz referans kodun kendisinden gelir ve hiçbir
ekstra iş.

Özel yorumlar `/**** ****/' (bir dosya için) ve `/*++++ ++++*/' (bir veri için
nesne) standart '/*' ve '*/' yorumunun içinde herhangi bir sayıda '*' veya '+' kullanılabilir
yorumlardaki sınırlayıcılar yoksayılır.

Bir yorum satırı boşlukla başlıyorsa ve ardından `+html+' geliyorsa, geri kalanı
satır yalnızca HTML çıktısına dahil edilir ve HTML'yi içerebilmesi için işlenmez
işaretleme, `-html-', satırın geri kalanının HTML hariç tümüne dahil edildiği anlamına gelir.
çıktı. Aynısı diğer çıktı biçimleri için de geçerlidir, satırlar için `+none+' kullanılabilir
herhangi bir çıktıda görünmemesi. Bunun istisnası, ham çıktının herhangi bir işlem yapmamasıdır.
kontrol eder ve tüm satırları çıkarır.

Bir yorumun `,', `;' takip ettiği herhangi bir durumda veya `)' yalnızca boşluklarla ayrılmış ve
sekmeler, yorum oradaki nesneye uygulanacak noktalama işaretinden önce itilir.

Program, bazı GCC uzantılarıyla birlikte tam bir ANSI C dilbilgisi ayrıştırıcısı kullanılarak uygulanır,
bu, kodun stilinin önemli olmadığı, yalnızca içerik ve yorumlar olduğu anlamına gelir.

Çapraz Referans
Çapraz referanslama aşağıdaki öğeler için gerçekleştirilir

dosyalar
Geçerli dosyanın dahil olduğu dosyalar
(diğer dosyalar aracılığıyla dahil edildiğinde bile).

#içerir
Geçerli dosyada bulunan dosyalar.
Bu dosyaların içerdiği dosyalar vb.

Değişkenler
Dış değişkenlerin tanımının yeri.
Global değişkenlerin görünürlüğüne sahip dosyalar.
Değişkeni kullanan dosyalar/işlevler.

fonksiyonlar
İşlevin prototipinin oluşturulduğu dosya.
Fonksiyonun çağırdığı fonksiyonlar.
İşlevi çağıran işlevler.
İşleve başvuran dosyalar ve işlevler.
Fonksiyonda kullanılan değişkenler.

Bu öğelerin her birine çıktıda çapraz referans verilir.

Çapraz referanslama, 'cxref.variable', 'cxref.function', 'cxref.include' ve 'cxref.include' dosyalarını kullanır.
`cxref.typedef' çıktı dizininde. Bunlar, işlevin tam listesidir ve
programda değişken kullanım ve bir işlev çağrısı hiyerarşisi oluşturmak için kullanılabilir veya
örneğin değişken kullanım şeması. Her dosya için iki cxref geçişi gereklidir, ilki
çapraz referans dosyalarını ve bunları kullanmak için ikincisini oluşturun.

(`-N' seçeneği kullanılıyorsa dosya adları farklıdır.)

Lateks Çıktı
Varsayılan LaTeX çıktısı, kaynak dosyaların her biri için bir ekstra dosya içeren bir dosyadır.
Diğer dosyaların her birini içeren `cxref.tex'. Bu, bir makefile'in yalnızca
değiştirilen dosyaları güncelleyin (referanslar tüm dosyaların
tekrar kontrol edildi). cxref.tex dosyası yazıldığında, kullanıcı tarafından değiştirilebilir,
eklenen tüm yeni dosyalar kaynak kod bölümünün sonuna eklenir, geri kalanı
dosya değişmiyor.

Dizin, `cxref.apdx.tex' adlı bir dosyaya yazılır ve cxref.tex, referans olarak güncellenir.
ona.

Ayrıca 'page.sty', 'fonts.sty' ve 'cxref.sty' olmak üzere üç LaTeX stil dosyası da yazılmıştır.
Bunlar, daha fazlasının görünmesini sağlamak için sayfayı daha küçük bir kenar boşluğu ve daha küçük yazı tipleri kullanacak şekilde ayarlar.
bir sayfa ve ayrıca cxref çıktısını dizmek için yeni komutları tanımlayın.

("-N" seçeneği seçiliyse, "cxref.tex" ve "cxref.apdx.tex" dosya adları farklıdır.
Kullanılmış.)

HTML Çıktı
Varsayılan HTML çıktısı, kaynak dosyaların her biri için fazladan bir dosya içeren bir dosyadır.
Diğer dosyaların her birini içeren `cxref.html'. Bu, bir makefile yalnızca
değiştirilen dosyaları güncelleyin (referanslar tüm dosyaların
tekrar kontrol edildi). cxref.html dosyası yazıldığında, kullanıcı tarafından değiştirilebilir,
eklenen herhangi bir yeni dosya, içindekiler tablosunun sonuna eklenir, gerisi
dosyanın değişmemesi.

İndeks, `cxref.apdx.html' adlı bir dosyaya yazılır ve cxref.html referans olarak güncellenir.
ona.

("-N" seçeneği seçiliyse, "cxref.html" ve "cxref.apdx.html" dosya adları farklıdır.
Kullanılmış.)

HTML çıktısı, HTML 4.01 standardını kullanır ve tüm sayfalar doğru şekilde doğrulanır.

RTF Çıktı
Zengin Metin Biçimi, Microsoft tarafından geliştirilen oldukça düşük düzeyli bir sayfa açıklama biçimidir. Bilişim Teknoloji
diğer formatlar gibi iyi tanımlanmış ve anlaşılması kolay bir standart değildir, ancak
belge değişimi için popüler.

Kaynak dosyaların her biri için tek bir çıktı dosyası ve bir dizin dosyası vardır.

SGML Çıktı
SGML bir üst dil olduğu için, yerleşim öğelerinin yanı sıra yerleşim öğelerini de tanımlamak gerekir.
bilgileri sağlayın. cxref çıktısı, LinuxDoc belge biçimini kullanır ve
SGMLtools programlarıyla kullanım için tasarlanmıştır (http://www.sgmltools.org/).

Kaynak dosyaların her biri için tek bir çıktı dosyası ve bir dizin dosyası vardır.

onworks.net hizmetlerini kullanarak cxref'i çevrimiçi kullanın