cxref - Online în cloud

PROGRAM:

NUME

cxref - C instrument de referințe încrucișate și documentare.

REZUMAT

cxref nume de fișier [ ... nume de fișier] [-Ospune-mi] [-Nnume de bază] [-Rnume de bază] [-toate-comentariile]
[-fara comentarii] [-comentarii-verbatim] [-block-comments]
[-xref[-all][-file][-func][-var][-type]] [-warn[-all][-comment][-xref]]
[-index[-all][-file][-func][-var][-type]] [-brut] [-latex] [-html[-src]] [-rtf] [-sgml]
[-Ispune-mi] [-Ddefini] [-Udefini] [-CPP program_cpp] [-- cpp_args ... cpp_args]

cxref nume de fișier [ ... nume de fișier] -șterge [-Ospune-mi] [-Nnume de bază] [-Rnume de bază]

DESCRIERE

Un program care poate genera automat documentație și referințe încrucișate pentru un C
programul.

Intrarea este orice program C cu comentarii adecvate, iar rezultatul este LaTeX, HTML, RTF sau
fișiere SGML.

OPŢIUNI

nume de fișier
Numele fișierului de documentat, orice număr de fișiere pot fi documentate la un moment dat.

-șterge
Fișierele numite vor fi șterse din directorul de ieșire și intrările lor în
baza de date cu referințe încrucișate și fișierele principale de ieșire urmează să fie eliminate.

-Odirname
Numele unui director de utilizat pentru fișierele latex de ieșire și locația fișierului
fișierele de referință încrucișată care sunt create.

-Nbasename
Numele de utilizat pentru prima parte a fișierelor de ieșire și referințe încrucișate
din cxref, extensiile de fișiere rămân aceleași.

-Rdirname
Când fișierele sursă se află în mai multe directoare, setați dirname la numele lui
directorul rădăcină al arborelui sursă (utilizați calea relativă dacă este mai ușor, de exemplu `-R../ ..').
Acesta va rula apoi cxref din acel director rădăcină și „-Odirname” trebuie să fie
raportat la acel director.

-toate-comentariile
În cazul în care credeți că comentariile existente ar putea funcționa, (vezi mai sus pentru descriere
de comentarii speciale). [Pericol! Această opțiune poate produce rezultate ciudate.]

-fara comentarii
Ignoră toate comentariile, util dacă doriți doar referințe încrucișate și nu
documentație.

-verbatim-comentarii
Când comentariile pe care le aveți în cod sunt formatate într-un stil prestabilit
pe care doriți să le păstrați la ieșire, această opțiune le va forța să nu fie
reformatată. [Notă, aceasta este doar pentru comentariile de fișiere și funcții.]

-blocare-comentarii
Când comentariile din program sunt formatate în stilul „bloc” (cu semnele de început
caracterul „*” pe fiecare linie), această opțiune va elimina acel caracter din
ieșire. [Funcționează pentru un singur `*', `+', `|' sau `:' pe fiecare linie.]

-xref Produceți informații de referință încrucișată (vezi mai jos).
-toate Toate referințele încrucișate.
-file Referințe încrucișate pentru fișiere.
-func Referințe încrucișate pentru funcții.
-var Referințe încrucișate pentru variabile.
-type Referințe încrucișate pentru tipuri.

-a avertiza Produceți avertismente, opțiunile trebuie concatenate împreună:
-toate Toate avertismentele.
-comment Avertizați despre comentariile lipsă.
-xref Avertizează despre referințe încrucișate lipsă.

-index Produceți un index de referință încrucișată, opțiunile trebuie să fie concatenate împreună:
-toți Toți indicii.
-fișier Indexul fișierelor.
-func Index de functii.
-var Indicele variabilelor.
-tip Indice de tipuri.

-brut Produceți o formă brută de ieșire, care nu este de mare folos, cu excepția utilizării -warn.

-latex Produceți un fișier LaTeX pentru a documenta fiecare dintre fișierele sursă și, de asemenea, un fișier suplimentar
care include fiecare dintre aceste fișiere.

-html Produceți un fișier HTML 4.01 pentru a documenta fiecare dintre fișierele sursă și un fișier principal
face referire la fiecare dintre aceste fișiere.

-html-src
Produceți rezultatul HTML și o versiune HTML a fișierului sursă cu link-uri către acesta.

-rtf Produceți un fișier în format text îmbogățit (RTF) pentru a documenta fișierul sursă.

-sgml Produceți un fișier SGML pentru a documenta fișierul sursă. (Folosind LinuxDoc DTD).

-Idirname
Opțiunea GCC pentru a specifica calea pentru fișierele incluse.

-Ddefiniți
Opțiunea GCC pentru a defini un simbol pre-procesor.

-Udefine
Opțiunea GCC pentru a nedefini un simbol pre-procesor.

-CPP program
Numele programului de utilizat în locul valorii implicite de timp de compilare. Programul
trebuie să poată efectua toate acțiunile pe care `gcc -E -C -dD' le face pentru a funcționa. Dacă
programul ia argumente, apoi totul trebuie să fie între ghilimele, astfel încât
este interpretat ca un singur argument pentru cxref.

--arg ... arg
Argumentele suplimentare care trebuie transmise pre-procesorului pot fi plasate după `--'
separator.

C compilator Înlocuire cxref-cc
Pentru a simplifica utilizarea cxref pe codul sursă existent, acum există un script shell care va face acest lucru
apelați compilatorul C și apoi apelați cxref pentru a procesa fișierul sursă. Aceasta înseamnă că
poate fi folosit ca o picătură de înlocuire pentru CC în Makefiles și altele asemenea.

Utilizare: cxref-cc [opțiuni cc obișnuite]

Numele fișierului sursă este extras din lista de opțiuni, precum și „-D*”,
`-I*', `-U*' și când compilatorul C iese cu succes va fi apelat cxref. The
numele compilatorului C de utilizat este controlat de variabila de mediu CXREFCC, sau dacă
aceasta nu este setată atunci variabila de mediu CC sau, în caz contrar, doar gcc.

Utilizarea acestui script necesită utilizarea unui fișier de configurare `.cxref' pentru a conține opțiunile
deoarece nu există unde să puneți opțiunile pe linia de comandă pentru compilatorul C.

Acest lucru va face doar referințe încrucișate și documente fișierele sursă C, deoarece acestea sunt singurele
cele care sunt compilate, dar se va asigura că sunt încrucișate cu
opțiuni corecte etc.

Cxref Configuraţie Fișier
Aceste argumente ale liniei de comandă pot fi, de asemenea, puse într-un fișier numit `.cxref' în loc de pe fișierul
Linie de comanda. Când se rulează cxref, argumentele programului sunt interpretate în
urmând ordinea.

(1) Cei de pe linia de comandă. (2) Cele din fișierul `.cxref' din directorul curent.
(3) Cele din fișierul `.cxref' din rădăcina arborelui sursă specificată de `-R'.

Aceasta înseamnă că într-un arbore sursă cu mai multe directoare, fiecare subdirector poate avea un „.cxref”
fișier care conține doar linia „-R..” sau corespunzătoare. Directorul principal poate avea un
Fișierul `.cxref' care conține restul opțiunilor. Acest lucru elimină complet nevoia
pentru a avea orice opțiune pe linia de comandă în afară de numele fișierelor sursă.

Formatul fișierului `.cxref' este orice număr de linii, fiecare conținând câte un singur
argument din linia de comandă (echivalent cu unul dintre argv). Singurele opțiuni care nu pot fi
utilizate sunt numele fișierelor sursă în sine și opțiunea „-delete”. Liniile goale sunt
ignorate, iar liniile care încep cu „#” sunt comentarii.

Program Documentație Comentarii
Documentația pentru program este produsă din comentarii din cod care sunt
formatat corespunzător. Referențele încrucișate provin din codul însuși și necesită nr
muncă în plus.

Comentariile speciale sunt `/**** ****/' (pentru un fișier) și `/*++++ ++++*/' (pentru o date
obiect) orice număr de „*” sau „+” poate fi folosit în interiorul comentariului standard „/*” și „*/”
delimitatori în comentarii, sunt ignorați.

Dacă o linie de comentariu începe cu spații albe și este urmată de `+html+', atunci restul
linia este inclusă numai în rezultatul HTML și nu este procesată, astfel încât să poată include HTML
marcaj, `-html-' înseamnă că restul liniei este inclus în toate, cu excepția HTML
ieșire. Același lucru este valabil și pentru celelalte formate de ieșire, `+none+' poate fi folosit pentru linii
să nu apară în nicio ieșire. Excepția de la aceasta este că rezultatul brut nu face nimic
verificând și va scoate toate liniile.

În orice situație în care un comentariu urmează un `,', `;' sau `)' separate doar prin spații și
file, comentariul este împins înainte de punctuația pentru a se aplica obiectului de acolo.

Programul este implementat folosind un parser gramatical ANSI C complet cu unele extensii GCC,
asta înseamnă că stilul codului este neimportant, doar conținutul și comentariile.

Trece Referențierea
Referențele încrucișate sunt efectuate pentru următoarele elemente

Fişiere
Fișierele în care este inclus fișierul curent
(chiar și atunci când sunt incluse prin alte fișiere).

#include
Fișierele incluse în fișierul curent.
Fișierele incluse în aceste fișiere etc.

Variabile
Locația definiției variabilelor externe.
Fișierele care au vizibilitate variabilelor globale.
Fișierele/funcțiile care utilizează variabila.

funcţii
Fișierul în care funcția este prototipată.
Funcțiile pe care le apelează funcția.
Funcțiile care apelează funcția.
Fișierele și funcțiile care fac referire la funcție.
Variabilele care sunt utilizate în funcție.

Fiecare dintre aceste elemente are referințe încrucișate în rezultat.

Referențele încrucișate utilizează fișierele `cxref.variable', `cxref.function', `cxref.include' și
`cxref.typedef' în directorul de ieșire. Acestea sunt o listă completă a funcției și
utilizare variabilă în program și ar putea fi folosită pentru a genera o ierarhie a apelurilor de funcție sau
diagrama de utilizare variabilă, de exemplu. Sunt necesare două treceri cxref pentru fiecare fișier, prima
construiți fișierele de referințe încrucișate și al doilea să le utilizați.

(Numele fișierelor sunt diferite dacă se folosește opțiunea `-N'.)

LaTeX producție
Ieșirea implicită LaTeX este un fișier pentru fiecare dintre fișierele sursă cu un fișier suplimentar
`cxref.tex' care include fiecare dintre celelalte fișiere. Acest lucru este pentru a permite doar unui makefile
actualizați fișierele modificate (deși referințele pot solicita ca toate fișierele să fie
verificat din nou). Când fișierul cxref.tex a fost scris, acesta poate fi modificat de către utilizator,
orice fișiere noi adăugate sunt adăugate la sfârșitul secțiunii de cod sursă, restul
fisierul fiind neschimbat.

Indexul este scris într-un fișier numit „cxref.apdx.tex”, iar cxref.tex este actualizat pentru a se referi
să-l.

De asemenea, sunt scrise trei fișiere în stil LaTeX `page.sty', `fonts.sty' și `cxref.sty'.
Acestea configurează pagina să folosească o marjă mai mică și fonturi mai mici pentru a permite să apară mai multe
o pagină și, de asemenea, definiți noile comenzi pentru compunerea ieșirii cxref.

(Numele de fișiere `cxref.tex' și `cxref.apdx.tex' sunt diferite dacă opțiunea `-N' este
folosit.)

HTML producție
Ieșirea HTML implicită este un fișier pentru fiecare dintre fișierele sursă cu un fișier suplimentar
`cxref.html' care include fiecare dintre celelalte fișiere. Acest lucru este pentru a permite doar unui makefile
actualizați fișierele modificate (deși referințele pot solicita ca toate fișierele să fie
verificat din nou). Când fișierul cxref.html a fost scris, acesta poate fi modificat de către utilizator,
orice fișiere noi care sunt adăugate sunt adăugate la sfârșit înainte de cuprins, restul
a fișierului fiind neschimbat.

Indexul este scris într-un fișier numit „cxref.apdx.html”, iar cxref.html este actualizat pentru a se referi
să-l.

(Numele fișierelor „cxref.html” și „cxref.apdx.html” sunt diferite dacă opțiunea „-N” este
folosit.)

Ieșirea HTML utilizează standardul HTML 4.01 și toate paginile sunt valide corect.

RTF producție
Rich Text Format este un format de descriere a paginii de nivel destul de scăzut conceput de Microsoft. Aceasta
nu este un standard bine definit și ușor de înțeles ca și celelalte formate, dar este
popular pentru schimbul de documente.

Există un singur fișier de ieșire pentru fiecare dintre fișierele sursă și un fișier index.

SGML producție
Deoarece SGML este un meta-limbaj, este necesar să se definească elementele de layout, precum și
furnizați informațiile. Ieșirea cxref folosește formatul de document LinuxDoc și este
conceput pentru a fi utilizat cu programele SGMLtools (http://www.sgmltools.org/).

Există un singur fișier de ieșire pentru fiecare dintre fișierele sursă și un fișier index.

Utilizați cxref online folosind serviciile onworks.net