cxref - Online di Cloud

PROGRAM:

NAMA

cxref - Alat Referensi & Dokumentasi Silang C.

RINGKASAN

cxref nama file [ ... nama file] [-HAInama dirname] [-Nnama dasar] [-Rnama dasar] [-semua-komentar]
[-tidak ada komentar] [-verbatim-komentar] [-blok-komentar]
[-xref[-semua][-file][-fungsi][-var][-tipe]] [-peringatan[-semua][-komentar][-xref]]
[-indeks[-semua][-file][-fungsi][-var][-tipe]] [-mentah] [-getah] [-html[-src]] [-rtf] [-sgml]
[-SAYAnama dirname] [-Dmenetapkan] [-kamumenetapkan] [-CPP cpp_program] [-- cpp_args ... cpp_args]

cxref nama file [ ... nama file] -menghapus [-HAInama dirname] [-Nnama dasar] [-Rnama dasar]

DESKRIPSI

Program yang dapat secara otomatis menghasilkan dokumentasi dan referensi silang untuk C
program.

Inputnya adalah program C apa pun dengan komentar yang sesuai dan outputnya adalah LaTeX, HTML, RTF atau
file SGML.

PILIHAN

nama file
Nama file untuk dokumen, sejumlah file dapat didokumentasikan pada suatu waktu.

-menghapus
File-file yang diberi nama akan dihapus dari direktori keluaran dan entri-entrinya di
database referensi silang dan file output utama harus dihapus.

-Nama Odir
Nama direktori yang akan digunakan untuk file lateks keluaran dan lokasi
file referensi silang yang dibuat.

-Nnama dasar
Nama yang akan digunakan untuk bagian pertama dari output dan file referensi silang sebagai gantinya
dari cxref, ekstensi file tetap sama.

-Nama asli
Ketika file sumber berada di lebih dari satu direktori, atur dirname ke nama
direktori root dari pohon sumber (gunakan jalur relatif jika lebih mudah misalnya `-R../ ..').
Ini kemudian akan menjalankan cxref dari direktori root itu dan `-Odirname' harus
relatif terhadap direktori itu.

-semua-komentar
Jika menurut Anda komentar yang ada mungkin berhasil, (lihat deskripsi di atas
komentar khusus). [Bahaya! Opsi ini dapat menghasilkan hasil yang aneh.]

-tidak ada komentar
Abaikan semua komentar, berguna jika Anda hanya ingin referensi silang dan bukan
dokumentasi.

-verbatim-komentar
Ketika komentar yang Anda miliki dalam kode diformat dengan gaya yang telah ditentukan
yang ingin Anda pertahankan pada output, opsi ini akan memaksa mereka untuk tidak menjadi
diformat ulang. [Catatan, ini hanya untuk komentar file dan fungsi.]

-blok-komentar
Ketika komentar dalam program diformat dalam gaya `blok' (dengan awalan
karakter '*' di setiap baris), opsi ini akan menghapus karakter tersebut dari
keluaran. [Berfungsi untuk satu `*', `+', `|' atau `:' di setiap baris.]

-xref Menghasilkan informasi referensi silang (lihat di bawah).
-semua Semua referensi silang.
-file Referensi silang untuk file.
-Func Referensi silang untuk fungsi.
-var Referensi silang untuk variabel.
-type Referensi silang untuk tipe.

-memperingatkan Menghasilkan peringatan, opsi harus digabungkan bersama:
-semua Semua peringatan.
-comment Peringatkan komentar yang hilang.
-xref Peringatkan referensi silang yang hilang.

-indeks Menghasilkan indeks referensi silang, opsi harus digabungkan bersama:
-semua Semua indeks.
-file Indeks file.
-Func Indeks fungsi.
-var Indeks variabel.
-type Indeks tipe.

-mentah Menghasilkan bentuk output mentah, tidak terlalu berguna kecuali dengan -warn.

-getah Menghasilkan file LaTeX untuk mendokumentasikan setiap file sumber dan juga file tambahan
yang mencakup masing-masing file ini.

-html Menghasilkan file HTML 4.01 untuk mendokumentasikan setiap file sumber dan file utama untuk
referensi masing-masing file ini.

-html-src
Menghasilkan output HTML dan versi HTML dari file sumber dengan link ke dalamnya.

-rtf Menghasilkan file Rich Text Format (RTF) untuk mendokumentasikan file sumber.

-sgml Menghasilkan file SGML untuk mendokumentasikan file sumber. (Menggunakan LinuxDoc DTD).

-Nama Idir
Opsi GCC untuk menentukan jalur untuk menyertakan file.

-tentukan
Opsi GCC untuk menentukan simbol pra-prosesor.

-Udefinasi
Opsi GCC untuk tidak menentukan simbol pra-prosesor.

-CPP program
Nama program yang akan digunakan sebagai pengganti waktu kompilasi default. Program
harus dapat melakukan semua tindakan yang dilakukan `gcc -E -C -dD' agar berfungsi. Jika
program mengambil argumen maka semuanya harus dalam tanda kutip sehingga
ditafsirkan sebagai argumen tunggal untuk cxref.

--arg ... arg
Argumen tambahan untuk diteruskan ke pra-prosesor dapat ditempatkan setelah `--'
pemisah.

C Penyusun Penggantian cxref-cc
Untuk menyederhanakan penggunaan cxref pada kode sumber yang ada, sekarang ada skrip shell yang akan
panggil kompiler C dan kemudian panggil cxref untuk memproses file sumber. Ini berarti bahwa
dapat digunakan sebagai pengganti CC di Makefiles dan sejenisnya.

Penggunaan: cxref-cc [opsi cc biasa]

Nama file sumber diekstraksi dari daftar opsi serta `-D*',
`-I*', `-U*' menandai dan ketika kompiler C keluar dengan sukses, cxref akan dipanggil. NS
nama kompiler C yang akan digunakan dikendalikan oleh variabel lingkungan CXREFCC, atau jika
ini tidak disetel maka variabel lingkungan CC, atau gagal ini hanya gcc.

Menggunakan skrip ini memerlukan penggunaan file konfigurasi `.cxref' untuk memuat opsi
karena tidak ada tempat untuk meletakkan opsi pada baris perintah untuk kompiler C.

Ini hanya akan melakukan referensi silang dan mendokumentasikan file sumber C karena hanya itu
yang dikompilasi, tetapi itu akan memastikan bahwa mereka direferensikan silang dengan
pilihan yang benar dll.

Cxref konfigurasi File
Argumen baris perintah ini juga dapat dimasukkan ke dalam file bernama `.cxref' alih-alih di
garis komando. Ketika cxref dijalankan, argumen ke program diinterpretasikan dalam
mengikuti pesanan.

(1) Mereka yang berada di baris perintah. (2) Yang ada di file `.cxref' di direktori saat ini.
(3) Yang ada di file `.cxref' di akar pohon sumber yang ditentukan oleh `-R'.

Ini berarti bahwa dalam pohon sumber multi-direktori, setiap sub-direktori dapat memiliki `.cxref'
file yang hanya berisi baris `-R..' atau yang sesuai. Direktori utama dapat memiliki a
File `.cxref' yang berisi sisa opsi. Ini menghilangkan sepenuhnya kebutuhan
untuk memiliki opsi apa pun pada baris perintah selain dari nama file sumber.

Format file `.cxref' adalah sejumlah baris, masing-masing berisi satu
argumen baris perintah (setara dengan salah satu argv). Satu-satunya pilihan yang tidak bisa
yang digunakan adalah nama file sumber itu sendiri dan opsi `-delete'. Garis kosong adalah
diabaikan dan baris yang dimulai dengan '#' adalah komentar.

program Dokumentasi komentar
Dokumentasi untuk program dihasilkan dari komentar dalam kode yang
diformat dengan tepat. Referensi silang berasal dari kode itu sendiri dan tidak memerlukan
kerja tambahan.

Komentar khusus adalah `/**** ****/' (untuk file) dan `/*++++ ++++*/' (untuk data
objek) sejumlah `*' atau `+' dapat digunakan di dalam komentar `/*' dan `*/' standar
pembatas di komentar, mereka diabaikan.

Jika baris komentar dimulai dengan spasi putih dan diikuti oleh `+html+', maka sisanya
baris hanya disertakan dalam output HTML, dan tidak diproses sehingga dapat menyertakan HTML
markup, `-html-' berarti bahwa sisa baris disertakan dalam semua kecuali HTML
keluaran. Hal yang sama juga berlaku untuk format output lainnya, `+none+' dapat digunakan untuk baris
untuk tidak muncul di output apa pun. Pengecualian untuk ini adalah bahwa output mentah tidak melakukan apa pun
memeriksa dan akan menampilkan semua baris.

Dalam situasi apa pun di mana komentar mengikuti `,', `;' atau `)' hanya dipisahkan oleh spasi dan
tab, komentar didorong ke sebelum tanda baca untuk diterapkan ke objek di sana.

Program ini diimplementasikan menggunakan pengurai tata bahasa ANSI C lengkap dengan beberapa ekstensi GCC,
ini berarti gaya kode tidak penting, hanya konten dan komentar.

Cross Referensi
Referensi silang dilakukan untuk item berikut:

File
File yang termasuk dalam file saat ini
(bahkan ketika disertakan melalui file lain).

#termasuk
File termasuk dalam file saat ini.
File yang disertakan oleh file-file ini dll.

Variabel
Lokasi definisi variabel eksternal.
File yang memiliki visibilitas variabel global.
File/fungsi yang menggunakan variabel.

Fungsi
File tempat fungsi dibuat prototipe.
Fungsi yang dipanggil oleh fungsi tersebut.
Fungsi yang memanggil fungsi.
File dan fungsi yang mereferensikan fungsi tersebut.
Variabel yang digunakan dalam fungsi.

Masing-masing item ini direferensikan silang dalam output.

Referensi silang menggunakan file `cxref.variable', `cxref.function', `cxref.include' dan
`cxref.typedef' di direktori keluaran. Ini adalah daftar lengkap fungsi dan
penggunaan variabel dalam program dan dapat digunakan untuk menghasilkan hierarki panggilan fungsi atau
diagram penggunaan variabel misalnya. Diperlukan dua pass cxref dari setiap file, yang pertama untuk
membangun file referensi silang dan yang kedua menggunakannya.

(Nama file berbeda jika opsi `-N' digunakan.)

Getah Keluaran
Output LaTeX default adalah file untuk setiap file sumber dengan satu file tambahan
`cxref.tex' yang menyertakan setiap file lainnya. Ini untuk memungkinkan makefile hanya
perbarui file yang diubah (walaupun referensi mungkin mengharuskan semua file menjadi
diperiksa lagi). Ketika file cxref.tex telah ditulis dapat dimodifikasi oleh pengguna,
setiap file baru yang ditambahkan ditambahkan di akhir bagian kode sumber, sisanya
file tidak berubah.

Indeks ditulis ke file bernama `cxref.apdx.tex' dan cxref.tex diperbarui untuk merujuk
untuk itu.

Juga ditulis tiga file gaya LaTeX `page.sty', `fonts.sty' dan `cxref.sty'.
Ini mengatur halaman untuk menggunakan margin yang lebih kecil dan font yang lebih kecil untuk memungkinkan lebih banyak muncul di
halaman dan juga menentukan perintah baru untuk pengaturan huruf keluaran cxref.

(Nama file `cxref.tex' dan `cxref.apdx.tex' berbeda jika opsi `-N' adalah
digunakan.)

HTML Keluaran
Output HTML default adalah file untuk setiap file sumber dengan satu file tambahan
`cxref.html' yang menyertakan setiap file lainnya. Ini untuk memungkinkan makefile hanya
perbarui file yang diubah (walaupun referensi mungkin mengharuskan semua file menjadi
diperiksa lagi). Ketika file cxref.html telah ditulis dapat dimodifikasi oleh pengguna,
setiap file baru yang ditambahkan ditambahkan di akhir sebelum daftar isi, sisanya
dari file yang tidak berubah.

Indeks ditulis ke file bernama `cxref.apdx.html' dan cxref.html diperbarui untuk merujuk
untuk itu.

(Nama file `cxref.html' dan `cxref.apdx.html' berbeda jika opsi `-N' adalah
digunakan.)

Output HTML menggunakan standar HTML 4.01 dan semua halaman divalidasi dengan benar.

RTF Keluaran
Rich Text Format adalah format deskripsi halaman tingkat rendah yang dirancang oleh Microsoft. Dia
bukan standar yang didefinisikan dengan baik dan mudah dipahami seperti format lainnya, tetapi ini adalah
populer untuk pertukaran dokumen.

Ada satu file output untuk masing-masing file sumber dan file indeks.

SGML Keluaran
Karena SGML adalah bahasa meta, perlu untuk mendefinisikan elemen tata letak serta
memberikan informasi. Keluaran cxref menggunakan format dokumen LinuxDoc dan adalah
dirancang untuk digunakan dengan program SGMLtools (http://www.sgmltools.org/).

Ada satu file output untuk masing-masing file sumber dan file indeks.

Gunakan cxref online menggunakan layanan onworks.net