cxref - Online sa Cloud

PROGRAMA:

NAME

cxref - C Cross Referencing & Documenting tool.

SINOPSIS

cxref filename [ ... filename] [-Odiname] [-Nbasename] [-Rbasename] [-all-comments]
[-walang komento] [-verbatim-comments] [-block-comments]
[-xref[-all][-file][-func][-var][-type]] [-warn[-all][-comment][-xref]]
[-index[-all][-file][-func][-var][-type]] [-raw] [-latex] [-html[-src]] [-rtf] [-sgml]
[-Akodiname] [-Dmagtakda] [-Umagtakda] [-CPP cpp_program] [-- cpp_args ... cpp_args]

cxref filename [ ... filename] -tanggalin [-Odiname] [-Nbasename] [-Rbasename]

DESCRIPTION

Isang program na maaaring awtomatikong bumuo ng dokumentasyon at mga cross reference para sa isang C
programa.

Ang input ay anumang C program na may naaangkop na mga komento at ang output ay LaTeX, HTML, RTF o
SGML file.

Opsyon

filename
Ang pangalan ng file na idodokumento, anumang bilang ng mga file ay maaaring idokumento sa isang pagkakataon.

-tanggalin
Ang mga file na pinangalanan ay tatanggalin mula sa output directory at ang kanilang mga entry
ang database ng cross reference at mga pangunahing output file ay aalisin.

-Odirname
Ang pangalan ng isang direktoryo na gagamitin para sa mga output na latex file at ang lokasyon ng
cross reference na mga file na ginawa.

-Nbasename
Ang pangalan na gagamitin para sa unang bahagi ng output at mga cross reference na file sa halip
ng cxref, ang mga extension ng file ay nananatiling pareho.

-Rdirname
Kapag ang mga source file ay nasa higit sa isang direktoryo, itakda ang dirname sa pangalan ng
ang root directory ng source tree (gumamit ng relative path kung mas madali eg `-R../..').
Ito ay tatakbo sa cxref mula sa root directory na iyon at ang `-Odirname' ay dapat
kaugnay sa direktoryong iyon.

-lahat ng mga komento
Kung sakaling sa tingin mo ay maaaring gumana ang mga kasalukuyang komento, (tingnan sa itaas para sa paglalarawan
ng mga espesyal na komento). [Panganib! Ang pagpipiliang ito ay maaaring makagawa ng mga kakaibang resulta.]

-walang komento
Binabalewala ang lahat ng komento, kapaki-pakinabang kung gusto mo lang ang mga cross reference at hindi ang
dokumentasyon.

-verbatim-komento
Kapag ang mga komento na mayroon ka sa code ay na-format sa isang paunang natukoy na istilo
na gusto mong panatilihin sa output, pipilitin ng pagpipiliang ito na huwag maging
na-reformat. [Tandaan, ito ay para lamang sa mga komento sa file at function.]

-block-comments
Kapag ang mga komento sa programa ay na-format sa istilong `block' (na may nangunguna
'*' character sa bawat linya), aalisin ng opsyong ito ang character na iyon mula sa
output. [Gumagana para sa isang solong `*', `+', `|' o `:' sa bawat linya.]

-xref Gumawa ng cross reference na impormasyon (tingnan sa ibaba).
-lahat Lahat ng mga cross reference.
-file Mga cross reference para sa mga file.
-func Mga cross reference para sa mga function.
-var Mga cross reference para sa mga variable.
-type Mga cross reference para sa mga uri.

-balaan Gumawa ng mga babala, ang mga opsyon ay dapat na pinagsama-sama:
-lahat Lahat ng mga babala.
-komento Babala sa mga nawawalang komento.
-xref Babala sa mga nawawalang cross reference.

-index Gumawa ng isang cross reference index, ang mga opsyon ay dapat na pinagsama-sama:
-lahat Lahat ng mga index.
-file Index ng mga file.
-func Index ng mga function.
-var Index ng mga variable.
-type Index ng mga uri.

-hilaw Gumawa ng isang hilaw na anyo ng output, hindi talaga gaanong pakinabang maliban sa -warn.

-latex Gumawa ng LaTeX file upang idokumento ang bawat isa sa mga source file at isa ring karagdagang file
na kinabibilangan ng bawat isa sa mga file na ito.

-html Gumawa ng HTML 4.01 na file para idokumento ang bawat source file at isang pangunahing file
sumangguni sa bawat isa sa mga file na ito.

-html-src
Gumawa ng HTML na output at isang HTML na bersyon ng source file na may mga link dito.

-rtf Gumawa ng Rich Text Format (RTF) na file para idokumento ang source file.

-sgml Gumawa ng SGML file para idokumento ang source file. (Gamit ang LinuxDoc DTD).

-Idirname
Opsyon ng GCC upang tukuyin ang landas para sa pagsasama ng mga file.

-Ddefine
GCC na opsyon para tukuyin ang isang pre-processor na simbolo.

-Udefine
Opsyon ng GCC na i-undefine ang isang pre-processor na simbolo.

-CPP programa
Ang pangalan ng program na gagamitin sa halip na ang oras ng pag-compile na default. Ang programa
dapat magawa ang lahat ng pagkilos na ginagawa ng `gcc -E -C -dD' upang gumana. Kung
ang programa ay tumatagal ng mga argumento pagkatapos ang buong bagay ay kailangang nasa mga panipi upang ito
ay binibigyang-kahulugan bilang isang solong argumento sa cxref.

--arg ... arg
Ang mga karagdagang argumento na ipapasa sa pre-processor ay maaaring ilagay pagkatapos ng `--'
naghihiwalay

C tagatala Kapalit cxref-cc
Upang gawing simple ang paggamit ng cxref sa umiiral na source code, mayroon na ngayong shell script na gagawin
tawagan ang C compiler at pagkatapos ay tawagan ang cxref para iproseso ang source file. Nangangahulugan ito na ito
ay maaaring gamitin bilang isang drop sa kapalit para sa CC sa Makefiles at ang katulad.

Paggamit: cxref-cc [mga karaniwang opsyon sa cc]

Ang pangalan ng source file ay kinuha mula sa listahan ng mga opsyon pati na rin ang `-D*',
Ang `-I*', `-U*' ay nag-flag at kapag matagumpay na lumabas ang C compiler ay tatawagin ang cxref. Ang
Ang pangalan ng C compiler na gagamitin ay kinokontrol ng CXREFCC environment variable, o kung
hindi ito nakatakda pagkatapos ang variable ng kapaligiran ng CC, o kung hindi ito gcc lang.

Ang paggamit ng script na ito ay nangangailangan ng paggamit ng `.cxref' configuration file upang maglaman ng mga opsyon
dahil walang kahit saan upang ilagay ang mga opsyon sa command line para sa C compiler.

Ito ay mag-cross-reference at magdodokumento lamang ng mga C source file dahil sila lang
mga pinagsama-sama, ngunit titiyakin nito na ang mga ito ay naka-cross-reference sa
tamang pagpipilian atbp.

Cxref Configuration talaksan
Ang mga argumento ng command line na ito ay maaari ding ilagay sa isang file na pinangalanang `.cxref' sa halip na sa
command line. Kapag ang cxref ay pinapatakbo ang mga argumento sa programa ay binibigyang kahulugan sa
sumusunod na order.

(1) Yaong nasa command line. (2) Ang mga nasa file na `.cxref' sa kasalukuyang direktoryo.
(3) Ang mga nasa `.cxref' na file sa pinagmulang ugat ng puno na tinukoy ng `-R'.

Nangangahulugan ito na sa isang multi-directory source tree, ang bawat sub-directory ay maaaring magkaroon ng `.cxref'
file na naglalaman lamang ng linyang `-R..' o naaangkop. Ang pangunahing direktoryo ay maaaring magkaroon ng a
`.cxref' na file na naglalaman ng natitira sa mga opsyon. Ito ay ganap na nag-aalis ng pangangailangan
upang magkaroon ng anumang mga opsyon sa command line bukod sa mga pangalan ng source file.

Ang format ng `.cxref' na file ay anumang bilang ng mga linya, bawat isa ay naglalaman ng isa
argumento ng command line (katumbas ng isa sa argv). Ang tanging mga pagpipilian na hindi maaaring maging
ginamit ay ang mga pangalan ng source file mismo at ang `-delete' na opsyon. Ang mga blangkong linya ay
hindi pinansin at ang mga linyang nagsisimula sa '#' ay mga komento.

Programa dokumentasyon Comments
Ang dokumentasyon para sa programa ay ginawa mula sa mga komento sa code na
angkop na na-format. Ang cross reference ay nagmula sa code mismo at nangangailangan ng hindi
Dagdag na trabaho.

Ang mga espesyal na komento ay `/**** ****/' (para sa isang file) at `/*++++ ++++*/' (para sa isang data
object) anumang bilang ng `*' o `+' ay maaaring gamitin sa loob ng karaniwang `/*' at `*/' na komento
delimiters sa comments, hindi sila pinapansin.

Kung ang isang linya ng komento ay nagsisimula sa whitespace at sinusundan ng `+html+' kung gayon ang iba pang bahagi ng
Ang linya ay kasama lamang sa HTML na output, at hindi pinoproseso upang maisama nito ang HTML
markup, `-html-' ay nangangahulugan na ang natitirang linya ay kasama sa lahat maliban sa HTML
output. Nalalapat din ito sa iba pang mga format ng output, maaaring gamitin ang `+none+' para sa mga linya
hindi upang lumitaw sa anumang output. Ang pagbubukod dito ay ang hilaw na output ay walang ginagawa
sinusuri at ilalabas ang lahat ng mga linya.

Sa anumang sitwasyon kung saan ang isang komento ay sumusunod sa isang `,', `;' o `)' na pinaghihiwalay lamang ng mga puwang at
tab, ang komento ay itinutulak sa bago ang bantas upang ilapat upang tumutol doon.

Ang programa ay ipinatupad gamit ang isang buong ANSI C grammar parser na may ilang mga extension ng GCC,
nangangahulugan ito na ang estilo ng code ay hindi mahalaga, tanging ang nilalaman at mga komento.

Tumawid Pagsangguni
Isinasagawa ang cross reference para sa mga sumusunod na item

File
Ang mga file kung saan kasama ang kasalukuyang file
(kahit na kasama sa pamamagitan ng iba pang mga file).

#kasama ang
Mga file na kasama sa kasalukuyang file.
Mga file na kasama ng mga file na ito atbp.

Variable
Ang lokasyon ng kahulugan ng mga panlabas na variable.
Ang mga file na may visibility ng mga global variable.
Ang mga file / function na gumagamit ng variable.

Pag-andar
Ang file kung saan na-prototype ang function.
Ang mga function na tinatawag ng function.
Ang mga function na tumatawag sa function.
Ang mga file at function na tumutukoy sa function.
Ang mga variable na ginagamit sa function.

Ang bawat isa sa mga item na ito ay naka-cross reference sa output.

Ang cross reference ay gumagamit ng mga file na `cxref.variable', `cxref.function', `cxref.include' at
`cxref.typedef' sa direktoryo ng output. Ito ay isang kumpletong listahan ng function at
variable na paggamit sa programa at maaaring magamit upang makabuo ng isang function call hierarchy o
variable na paggamit diagram halimbawa. Dalawang cxref pass ng bawat file ang kailangan, ang una sa
buuin ang mga cross reference na file at ang pangalawa upang gamitin ang mga ito.

(Ang mga pangalan ng file ay iba kung ang `-N' na opsyon ay ginagamit.)

LaTeX Pagbubuhos
Ang default na LaTeX na output ay isang file para sa bawat isa sa mga source file na may isang karagdagang file
`cxref.tex' na kinabibilangan ng bawat isa sa iba pang mga file. Ito ay upang payagan ang isang makefile na lamang
i-update ang mga binagong file (bagaman ang mga sanggunian ay maaaring mangailangan ng lahat ng mga file na
sinuri muli). Kapag naisulat na ang cxref.tex file maaari itong baguhin ng user,
anumang mga bagong file na idinagdag ay idinaragdag sa dulo ng seksyon ng source code, ang iba pa
ang file ay hindi nagbabago.

Ang index ay isinulat sa isang file na tinatawag na `cxref.apdx.tex' at ang cxref.tex ay ina-update upang sumangguni
dito.

Isinulat din ang tatlong LaTeX style file na `page.sty', `fonts.sty' at `cxref.sty'.
Ang mga ito ay nagse-set up ng page para gumamit ng mas maliit na margin at mas maliliit na font para mas marami pang lumabas
isang pahina at tukuyin din ang mga bagong command para sa pag-type ng cxref output.

(Ang mga pangalan ng file na `cxref.tex' at `cxref.apdx.tex' ay iba kung ang `-N' na opsyon ay
ginamit.)

HTML Pagbubuhos
Ang default na HTML na output ay isang file para sa bawat isa sa mga source file na may isang karagdagang file
`cxref.html' na kinabibilangan ng bawat isa sa iba pang mga file. Ito ay upang payagan ang isang makefile na lamang
i-update ang mga binagong file (bagaman ang mga sanggunian ay maaaring mangailangan ng lahat ng mga file na
sinuri muli). Kapag naisulat na ang cxref.html file maaari itong baguhin ng user,
anumang mga bagong file na idinagdag ay idinaragdag sa dulo bago ang talaan ng mga nilalaman, ang iba pa
ng file na hindi nagbabago.

Ang index ay isinulat sa isang file na tinatawag na `cxref.apdx.html' at ang cxref.html ay ina-update upang sumangguni
dito.

(Ang mga pangalan ng file na `cxref.html' at `cxref.apdx.html' ay iba kung ang `-N' na opsyon ay
ginamit.)

Ang HTML na output ay gumagamit ng HTML 4.01 na pamantayan at lahat ng mga pahina ay napapatunayan nang tama.

RTF Pagbubuhos
Ang Rich Text Format ay isang medyo mababang antas ng format ng paglalarawan ng pahina na ginawa ng Microsoft. Ito
ay hindi isang mahusay na tinukoy at madaling maunawaan na pamantayan tulad ng iba pang mga format, ngunit ito ay
sikat para sa pagpapalitan ng dokumento.

Mayroong isang solong output file para sa bawat isa sa mga source file at isang index file.

SGML Pagbubuhos
Dahil ang SGML ay isang meta-language ito ay kinakailangan upang tukuyin ang mga elemento ng layout pati na rin
ibigay ang impormasyon. Ang cxref output ay gumagamit ng LinuxDoc na format ng dokumento at ay
idinisenyo para gamitin sa mga programang SGMLtools (http://www.sgmltools.org/).

Mayroong isang solong output file para sa bawat isa sa mga source file at isang index file.

Gumamit ng cxref online gamit ang mga serbisyo ng onworks.net