cxref - Dalam talian dalam Awan

JADUAL:

NAMA

cxref - Alat Rujukan & Pendokumentasian C.

SINOPSIS

cxref nama fail [ ... nama fail] [-Onama panggilan] [-Nnama asas] [-Rnama asas] [-semua-komen]
[-tiada komen] [-verbatim-komen] [-sekat-komen]
[-xref[-all][-file][-func][-var][-type]] [-amaran[-semua][-komen][-xref]]
[-index[-all][-file][-func][-var][-type]] [-mentah] [-lateks] [-html[-src]] [-rtf] [-sgml]
[-Sayanama panggilan] [-Dmenentukan] [-Umenentukan] [-CPP cpp_program] [-- cpp_args ... cpp_args]

cxref nama fail [ ... nama fail] -hapuskan [-Onama panggilan] [-Nnama asas] [-Rnama asas]

DESCRIPTION

Program yang boleh menjana dokumentasi dan rujukan silang secara automatik untuk C
program.

Input adalah mana-mana program C dengan komen yang sesuai dan output adalah LaTeX, HTML, RTF atau
fail SGML.

PILIHAN

nama fail
Nama fail untuk didokumenkan, sebarang bilangan fail boleh didokumenkan pada satu masa.

-hapuskan
Fail yang dinamakan akan dipadamkan daripada direktori output dan entrinya
pangkalan data rujukan silang dan fail output utama akan dialih keluar.

-Nama Odir
Nama direktori untuk digunakan untuk fail lateks output dan lokasi fail
fail rujukan silang yang dibuat.

-Nbasename
Nama untuk digunakan untuk bahagian pertama output dan fail rujukan silang sebaliknya
daripada cxref, sambungan fail kekal sama.

-Rdirname
Apabila fail sumber berada dalam lebih daripada satu direktori, tetapkan diname kepada nama
direktori akar pokok sumber (gunakan laluan relatif jika lebih mudah cth `-R../ ..').
Ini kemudiannya akan menjalankan cxref dari direktori akar itu dan `-Odirname' mestilah
berbanding dengan direktori itu.

-semua-komen
Sekiranya anda berpendapat bahawa ulasan sedia ada mungkin berfungsi, (lihat di atas untuk penerangan
komen khas). [Bahaya! Pilihan ini boleh menghasilkan hasil yang pelik.]

-tiada komen
Abaikan semua komen, berguna jika anda hanya mahukan rujukan silang dan bukan
dokumentasi.

-komen-verbatim
Apabila komen yang anda ada dalam kod diformatkan dalam gaya yang telah ditetapkan
yang anda ingin simpan pada output, pilihan ini akan memaksa mereka untuk tidak menjadi
diformat semula. [Nota, ini adalah untuk komen fail dan fungsi sahaja.]

-sekat-komen
Apabila komen dalam program diformatkan dalam gaya `blok' (dengan petunjuk
aksara '*' pada setiap baris), pilihan ini akan mengalih keluar aksara itu daripada
pengeluaran. [Berfungsi untuk satu `*', `+', `|' atau `:' pada setiap baris.]

-xref Menghasilkan maklumat rujukan silang (lihat di bawah).
-semua Semua rujukan silang.
-fail Rujukan silang untuk fail.
-func Rujukan silang untuk fungsi.
-var Rujukan silang untuk pembolehubah.
-jenis Rujukan silang untuk jenis.

-amaran Menghasilkan amaran, pilihan mesti digabungkan bersama:
-semua Semua amaran.
-komen Amaran tiada komen.
-xref Amaran tiada rujukan silang.

-indeks Hasilkan indeks rujukan silang, pilihan mesti digabungkan bersama:
-semua Semua indeks.
-fail Indeks fail.
-func Indeks fungsi.
-var Indeks pembolehubah.
-jenis Indeks jenis.

-mentah Menghasilkan bentuk output mentah, tidak begitu banyak digunakan kecuali dengan -warn.

-lateks Hasilkan fail LaTeX untuk mendokumenkan setiap fail sumber dan juga fail tambahan
yang merangkumi setiap fail ini.

-html Hasilkan fail HTML 4.01 untuk mendokumentasikan setiap fail sumber dan fail utama
rujuk setiap fail ini.

-html-src
Hasilkan output HTML dan versi HTML fail sumber dengan pautan ke dalamnya.

-rtf Hasilkan fail Rich Text Format (RTF) untuk mendokumenkan fail sumber.

-sgml Hasilkan fail SGML untuk mendokumenkan fail sumber. (Menggunakan LinuxDoc DTD).

-Idirname
Pilihan GCC untuk menentukan laluan untuk memasukkan fail.

-Ddefine
Pilihan GCC untuk menentukan simbol pra-pemproses.

-Udefine
Pilihan GCC untuk menyahtakrif simbol pra-pemproses.

-CPP program
Nama program untuk digunakan dan bukannya lalai masa kompilasi. Program yang
mesti boleh melakukan semua tindakan yang `gcc -E -C -dD' lakukan untuk berfungsi. Jika
program mengambil hujah maka semuanya perlu dalam petikan supaya ia
ditafsirkan sebagai satu hujah kepada cxref.

--berhujah ... berhujah
Argumen tambahan untuk dihantar ke pra-pemproses boleh diletakkan selepas `--'
pemisah.

C Pengkompil Penggantian cxref-cc
Untuk memudahkan penggunaan cxref pada kod sumber sedia ada, kini terdapat skrip shell yang akan
panggil pengkompil C dan kemudian panggil cxref untuk memproses fail sumber. Ini bermakna bahawa ia
boleh digunakan sebagai penurunan dalam penggantian untuk CC dalam Makefiles dan seumpamanya.

Penggunaan: cxref-cc [pilihan cc biasa]

Nama fail sumber diekstrak daripada senarai pilihan serta `-D*',
Bendera `-I*', `-U*' dan apabila pengkompil C berjaya keluar, cxref akan dipanggil. The
nama pengkompil C untuk digunakan dikawal oleh pembolehubah persekitaran CXREFCC, atau jika
ini tidak ditetapkan maka pembolehubah persekitaran CC, atau gagal ini hanya gcc.

Menggunakan skrip ini memerlukan penggunaan fail konfigurasi `.cxref' untuk mengandungi pilihan
kerana tiada tempat untuk meletakkan pilihan pada baris arahan untuk pengkompil C.

Ini hanya akan merujuk silang dan mendokumenkan fail sumber C kerana ia adalah satu-satunya
yang disusun, tetapi ia akan memastikan bahawa ia dirujuk silang dengan
pilihan yang betul dsb.

Cxref konfigurasi File
Argumen baris arahan ini juga boleh dimasukkan ke dalam fail bernama `.cxref' dan bukannya pada
baris arahan. Apabila cxref dijalankan, argumen kepada program ditafsirkan dalam
mengikut perintah.

(1) Mereka yang berada di baris arahan. (2) Mereka dalam fail `.cxref' dalam direktori semasa.
(3) Mereka dalam fail `.cxref' dalam akar pokok sumber yang ditentukan oleh `-R'.

Ini bermakna bahawa dalam pepohon sumber berbilang direktori, setiap subdirektori boleh mempunyai `.cxref'
fail yang mengandungi hanya baris `-R..' atau yang sesuai. Direktori utama boleh mempunyai a
Fail `.cxref' yang mengandungi baki pilihan. Ini menghilangkan sepenuhnya keperluan
untuk mempunyai sebarang pilihan pada baris arahan selain daripada nama fail sumber.

Format fail `.cxref' ialah sebarang bilangan baris, setiap satu mengandungi satu baris
hujah baris arahan (bersamaan dengan salah satu argv). Satu-satunya pilihan yang tidak boleh
yang digunakan ialah nama fail sumber itu sendiri dan pilihan `-delete'. Garis kosong ialah
diabaikan dan baris bermula dengan '#' adalah ulasan.

Program dokumentasi Komen-komen
Dokumentasi untuk program dihasilkan daripada komen dalam kod yang
diformatkan dengan sewajarnya. Rujukan silang datang daripada kod itu sendiri dan tidak memerlukan
kerja lebih.

Komen khas ialah `/**** ****/' (untuk fail) dan `/*++++ ++++*/' (untuk data
objek) sebarang bilangan `*' atau `+' boleh digunakan di dalam komen `/*' dan `*/' standard
pembatas dalam komen, mereka diabaikan.

Jika baris ulasan bermula dengan ruang putih dan diikuti dengan `+html+' maka barisan yang lain
baris disertakan hanya dalam output HTML, dan tidak diproses supaya ia boleh memasukkan HTML
markup, `-html-' bermaksud bahawa baris yang lain disertakan dalam semua kecuali HTML
pengeluaran. Perkara yang sama juga berlaku untuk format output lain, `+tiada+' boleh digunakan untuk baris
tidak muncul dalam mana-mana output. Pengecualian untuk ini adalah bahawa output mentah tidak melakukan apa-apa
menyemak dan akan mengeluarkan semua baris.

Dalam mana-mana keadaan di mana komen mengikut `,', `;' atau `)' hanya dipisahkan oleh ruang dan
tab, ulasan ditolak ke sebelum tanda baca untuk digunakan untuk membantah di sana.

Program ini dilaksanakan menggunakan penghurai tatabahasa ANSI C penuh dengan beberapa sambungan GCC,
ini bermakna gaya kod tidak penting, hanya kandungan dan ulasan.

Menyeberang Rujukan
Rujukan silang dilakukan untuk perkara berikut

Fail
Fail yang disertakan dengan fail semasa
(walaupun disertakan melalui fail lain).

#termasuk
Fail yang disertakan dalam fail semasa.
Fail yang disertakan oleh fail ini dsb.

Pembolehubah
Lokasi definisi pembolehubah luaran.
Fail yang mempunyai keterlihatan pembolehubah global.
Fail / fungsi yang menggunakan pembolehubah.

Fungsi
Fail yang berfungsi sebagai prototaip.
Fungsi yang dipanggil oleh fungsi.
Fungsi yang memanggil fungsi.
Fail dan fungsi yang merujuk fungsi.
Pembolehubah yang digunakan dalam fungsi.

Setiap item ini dirujuk silang dalam output.

Rujukan silang menggunakan fail `cxref.variable', `cxref.function', `cxref.include' dan
`cxref.typedef' dalam direktori output. Ini adalah senarai lengkap fungsi dan
penggunaan berubah-ubah dalam program dan boleh digunakan untuk menjana hierarki panggilan fungsi atau
contoh rajah penggunaan berubah-ubah. Dua pas cxref setiap fail diperlukan, yang pertama untuk
membina fail rujukan silang dan yang kedua untuk menggunakannya.

(Nama fail berbeza jika pilihan `-N' digunakan.)

LaTeX Output
Output LaTeX lalai ialah fail untuk setiap fail sumber dengan satu fail tambahan
`cxref.tex' yang merangkumi setiap satu daripada fail lain. Ini adalah untuk membenarkan makefile hanya
kemas kini fail yang diubah (walaupun rujukan mungkin memerlukan semua fail
diperiksa semula). Apabila fail cxref.tex telah ditulis, ia boleh diubah suai oleh pengguna,
mana-mana fail baharu yang ditambahkan ditambahkan pada penghujung bahagian kod sumber, bahagian lain
fail tidak berubah.

Indeks ditulis pada fail yang dipanggil `cxref.apdx.tex' dan cxref.tex dikemas kini untuk merujuk
kepadanya.

Turut ditulis ialah tiga fail gaya LaTeX `page.sty', `fonts.sty' dan `cxref.sty'.
Ini menyediakan halaman untuk menggunakan margin yang lebih kecil dan fon yang lebih kecil untuk membolehkan lebih banyak dipaparkan
halaman dan juga mentakrifkan arahan baharu untuk menaip output cxref.

(Nama fail `cxref.tex' dan `cxref.apdx.tex' adalah berbeza jika pilihan `-N' ialah
digunakan.)

HTML Output
Output HTML lalai ialah fail untuk setiap fail sumber dengan satu fail tambahan
`cxref.html' yang merangkumi setiap satu daripada fail lain. Ini adalah untuk membenarkan makefile hanya
kemas kini fail yang diubah (walaupun rujukan mungkin memerlukan semua fail
diperiksa semula). Apabila fail cxref.html telah ditulis, ia boleh diubah suai oleh pengguna,
mana-mana fail baharu yang ditambah ditambah pada penghujung sebelum jadual kandungan, selebihnya
daripada fail tidak berubah.

Indeks ditulis pada fail yang dipanggil `cxref.apdx.html' dan cxref.html dikemas kini untuk merujuk
kepadanya.

(Nama fail `cxref.html' dan `cxref.apdx.html' adalah berbeza jika pilihan `-N' ialah
digunakan.)

Output HTML menggunakan standard HTML 4.01 dan semua halaman disahkan dengan betul.

Rtf Output
Format Teks Kaya ialah format penerangan halaman tahap yang agak rendah yang direka oleh Microsoft. Ia
bukanlah piawaian yang ditakrifkan dengan baik dan mudah difahami seperti format lain, tetapi ia adalah
popular untuk pertukaran dokumen.

Terdapat satu fail output untuk setiap fail sumber dan fail indeks.

SGML Output
Memandangkan SGML ialah bahasa meta adalah perlu untuk menentukan elemen susun atur serta
memberikan maklumat tersebut. Output cxref menggunakan format dokumen LinuxDoc dan adalah
direka untuk digunakan dengan program SGMLtools (http://www.sgmltools.org/).

Terdapat satu fail output untuk setiap fail sumber dan fail indeks.

Gunakan cxref dalam talian menggunakan perkhidmatan onworks.net