cxref - Online in de cloud

PROGRAMMA:

NAAM

cxref - C Kruisverwijzings- en documentatietool.

KORTE INHOUD

cxref bestandsnaam [ ... bestandsnaam] [-Ozeg eens] [-Nbasisnaam] [-Rbasisnaam] [-alle-reacties]
[-Geen reacties] [-woordelijke opmerkingen] [-blok-opmerkingen]
[-xref[-alle][-bestand][-func][-var][-type]] [-warn[-all][-commentaar][-xref]]
[-index[-alles][-bestand][-func][-var][-type]] [-rauw] [-latex] [-html[-src]] [-rtf] [-sgml]
[-Lzeg eens] [-NSbepalen] [-Ubepalen] [-CPP cpp_programma] [-- cpp_args ... cpp_args]

cxref bestandsnaam [ ... bestandsnaam] -delete [-Ozeg eens] [-Nbasisnaam] [-Rbasisnaam]

PRODUCTBESCHRIJVING

Een programma dat automatisch documentatie en kruisverwijzingen kan genereren voor een C
programma.

De invoer is elk C-programma met de juiste opmerkingen en de uitvoer is LaTeX, HTML, RTF of
SGML-bestanden.

OPTIES

bestandsnaam
De naam van het te documenteren bestand. Er kan een willekeurig aantal bestanden tegelijk worden gedocumenteerd.

-delete
De genoemde bestanden moeten worden verwijderd uit de uitvoermap en hun vermeldingen in
de kruisverwijzingsdatabase en de belangrijkste uitvoerbestanden moeten worden verwijderd.

-Odirnaam
De naam van een map die moet worden gebruikt voor de uitvoerlatexbestanden en de locatie van het
kruisverwijzingsbestanden die zijn gemaakt.

-Nbasisnaam
De naam die in plaats daarvan moet worden gebruikt voor het eerste deel van de uitvoer- en kruisverwijzingsbestanden
van cxref blijven de bestandsextensies hetzelfde.

-Rdirnaam
Wanneer de bronbestanden zich in meer dan één map bevinden, stelt u dirname in op de naam van
de hoofdmap van de bronboom (gebruik het relatieve pad als dit gemakkelijker is, bijvoorbeeld `-R../..').
Dit zal dan cxref uitvoeren vanuit die hoofdmap en de `-Odirname' moet zijn
ten opzichte van die map.

-alle-reacties
Als u denkt dat de bestaande opmerkingen zouden kunnen werken, (zie hierboven voor beschrijving
van speciale opmerkingen). [Gevaar! Deze optie kan vreemde resultaten opleveren.]

-Geen reacties
Negeert alle opmerkingen, handig als u alleen de kruisverwijzingen wilt en niet de
documentatie.

-woordelijke-opmerkingen
Wanneer de opmerkingen die u in de code heeft, in een vooraf bepaalde stijl zijn opgemaakt
die u op de uitvoer wilt behouden, dwingt deze optie dat dit niet het geval is
opnieuw geformatteerd. [Opmerking: dit is alleen voor bestands- en functieopmerkingen.]

-blok-opmerkingen
Wanneer de commentaren in het programma zijn opgemaakt in de 'blok'-stijl (met een voorafgaande
'*' teken op elke regel), zal deze optie dat teken verwijderen uit de
uitgang. [Werkt voor een enkele `*', `+', `|' of `:' op elke regel.]

-xref Maak kruisverwijzingsinformatie (zie hieronder).
-all Alle kruisverwijzingen.
-file Kruisverwijzingen voor bestanden.
-func Kruisverwijzingen voor functies.
-var Kruisverwijzingen voor variabelen.
-type Kruisverwijzingen voor typen.

-waarschuwen Waarschuwingen produceren, de opties moeten aaneengeschakeld worden:
-alle Alle waarschuwingen.
-comment Waarschuw voor ontbrekende reacties.
-xref Waarschuw voor ontbrekende kruisverwijzingen.

-inhoudsopgave Maak een kruisverwijzingsindex, de opties moeten aan elkaar worden gekoppeld:
-all Alle indexen.
-file Index van bestanden.
-func Index van functies.
-var Index van variabelen.
-type Index van typen.

-trekken Produceer een ruwe vorm van uitvoer, die niet echt veel nut heeft, behalve met -warn.

-latex Maak een LaTeX-bestand om elk van de bronbestanden te documenteren, en ook een extra bestand
dat elk van deze bestanden bevat.

-html Maak een HTML 4.01-bestand om elk van de bronbestanden en een hoofdbestand in te documenteren
verwijzen naar elk van deze bestanden.

-html-src
Produceer de HTML-uitvoer en een HTML-versie van het bronbestand met links erin.

-rtf Maak een RTF-bestand (Rich Text Format) om het bronbestand te documenteren.

-sgml Maak een SGML-bestand om het bronbestand te documenteren. (Met behulp van de LinuxDoc DTD).

-Idirnaam
GCC-optie om het pad voor include-bestanden op te geven.

-Ddefinieer
GCC-optie om een ​​pre-processorsymbool te definiëren.

-Udefine
GCC-optie om de definitie van een pre-processorsymbool ongedaan te maken.

-CPP programma
De naam van het programma dat moet worden gebruikt in plaats van de standaardwaarde voor het compileren. Het programma
moet in staat zijn om alle acties uit te voeren die `gcc -E -C -dD' doet om te werken. Als
Als het programma argumenten gebruikt, moet het geheel tussen aanhalingstekens staan, zodat het klopt
wordt geïnterpreteerd als een enkel argument voor cxref.

--arg ... arg
Extra argumenten die aan de pre-processor moeten worden doorgegeven, kunnen na de `--' worden geplaatst
scheidingsteken.

C Compiler Vervanging cxref-cc
Om het gebruik van cxref op bestaande broncode te vereenvoudigen, is er nu een shellscript dat dat wel doet
roep de C-compiler aan en roep vervolgens cxref aan om het bronbestand te verwerken. Dit betekent dat het
kan worden gebruikt als vervanging voor CC in Makefiles en dergelijke.

Gebruik: cxref-cc [gebruikelijke cc-opties]

De naam van het bronbestand wordt uit de lijst met opties gehaald, evenals de `-D*',
`-I*', `-U*' vlaggen en wanneer de C-compiler succesvol afsluit, zal cxref worden aangeroepen. De
De naam van de te gebruiken C-compiler wordt bepaald door de CXREFCC-omgevingsvariabele, of if
dit is niet ingesteld dan de CC-omgevingsvariabele, of als dit niet lukt gewoon gcc.

Het gebruik van dit script vereist het gebruik van een `.cxref'-configuratiebestand om de opties te bevatten
omdat er nergens de opties op de opdrachtregel voor de C-compiler kunnen worden geplaatst.

Dit zal alleen verwijzen naar en documenteren van de C-bronbestanden, aangezien dit de enige zijn
degenen die zijn gecompileerd, maar het zorgt ervoor dat er kruisverwijzingen naar worden gemaakt
juiste opties enz.

Cxref Configuratie Dien in
Deze opdrachtregelargumenten kunnen ook in een bestand met de naam `.cxref' worden geplaatst in plaats van op het
opdrachtregel. Wanneer cxref wordt uitgevoerd, worden de argumenten voor het programma geïnterpreteerd in het
volgorde.

(1) Degenen op de opdrachtregel. (2) Die in het `.cxref'-bestand in de huidige map.
(3) Die in het `.cxref'-bestand in de bronboomwortel gespecificeerd door `-R'.

Dit betekent dat in een bronboom met meerdere mappen elke submap een `.cxref' kan hebben
bestand dat alleen de regel `-R..' of een toepasselijke regel bevat. De hoofdmap kan een
`.cxref'-bestand met de overige opties. Dit neemt de noodzaak volledig weg
om opties op de opdrachtregel te hebben, afgezien van de bronbestandsnamen.

Het formaat van het `.cxref'-bestand is een willekeurig aantal regels, waarbij elke regel één regel bevat
opdrachtregelargument (equivalent aan een van de argv). De enige opties die dat niet kunnen zijn
gebruikt zijn de namen van de bronbestanden zelf en de `-delete' optie. Lege regels zijn
genegeerd en regels die beginnen met een '#' zijn commentaar.

Programma Documentatie Heb je vragen? Stel ze hier.
De documentatie voor het programma wordt geproduceerd op basis van commentaar in de code
op de juiste manier geformatteerd. De kruisverwijzingen komen uit de code zelf en vereisen nee
extra werk.

De speciale opmerkingen zijn `/**** ****/' (voor een bestand) en `/*++++ ++++**/' (voor een gegevensbestand)
object) kan een willekeurig aantal `*' of `+' worden gebruikt binnen de standaard `/*' en `*/' commentaar
scheidingstekens in de opmerkingen worden genegeerd.

Als een commentaarregel begint met witruimte en wordt gevolgd door `+html+', dan wordt de rest van de
regel wordt alleen opgenomen in de HTML-uitvoer en wordt niet verwerkt, zodat deze HTML kan bevatten
markup betekent `-html-' dat de rest van de regel in alle regels is opgenomen, behalve in de HTML
uitgang. Hetzelfde geldt ook voor de andere uitvoerformaten, voor regels kan `+none+' worden gebruikt
om in geen enkele uitvoer te verschijnen. De uitzondering hierop is dat de onbewerkte uitvoer niets doet
controleren en alle regels uitvoeren.

In elke situatie waarin een opmerking volgt op een `,', `;' of `)' alleen gescheiden door spaties en
tabbladen wordt de opmerking vóór de leestekens geplaatst om daar bezwaar te maken.

Het programma is geïmplementeerd met behulp van een volledige ANSI C-grammaticaparser met enkele GCC-extensies,
dit betekent dat de stijl van de code onbelangrijk is, alleen de inhoud en het commentaar.

Cross Verwijzen
De kruisverwijzingen worden uitgevoerd voor de volgende items

Bestanden
De bestanden waarin het huidige bestand is opgenomen
(zelfs wanneer opgenomen via andere bestanden).

#inclusief
Bestanden die zijn opgenomen in het huidige bestand.
Bestanden die bij deze bestanden horen enz.

Variabelen
De locatie van de definitie van externe variabelen.
De bestanden met zichtbaarheid van globale variabelen.
De bestanden/functies die de variabele gebruiken.

Functies
Het bestand waarin een prototype van de functie wordt gemaakt.
De functies die de functie aanroept.
De functies die de functie aanroepen.
De bestanden en functies die naar de functie verwijzen.
De variabelen die in de functie worden gebruikt.

Naar elk van deze items wordt in de uitvoer verwezen.

De kruisverwijzingen maken gebruik van de bestanden `cxref.variable', `cxref.function', `cxref.include' en
`cxref.typedef' in de uitvoermap. Dit is een volledige lijst van de functie en
variabel gebruik in het programma en kan worden gebruikt om een ​​functieaanroephiërarchie te genereren of
variabel gebruiksdiagram bijvoorbeeld. Er zijn twee cxref-doorgangen voor elk bestand nodig, de eerste moet
de kruisverwijzingsbestanden opbouwen en de tweede om ze te gebruiken.

(De bestandsnamen zijn anders als de optie `-N' wordt gebruikt.)

Latex uitgang
De standaard LaTeX-uitvoer is een bestand voor elk van de bronbestanden met één extra bestand
`cxref.tex' dat elk van de andere bestanden bevat. Dit is om alleen een makefile mogelijk te maken
de gewijzigde bestanden bijwerken (hoewel de verwijzingen mogelijk vereisen dat alle bestanden
nogmaals gecontroleerd). Wanneer het cxref.tex-bestand is geschreven, kan het door de gebruiker worden gewijzigd,
alle nieuwe bestanden die worden toegevoegd, worden toegevoegd aan het einde van de broncodesectie, de rest van de sectie
het bestand blijft ongewijzigd.

De index wordt geschreven naar een bestand met de naam `cxref.apdx.tex' en cxref.tex wordt bijgewerkt om te verwijzen
aan.

Ook uitgeschreven zijn drie LaTeX-stijlbestanden `page.sty', `fonts.sty' en `cxref.sty'.
Deze zorgen ervoor dat de pagina een kleinere marge en kleinere lettertypen gebruikt, zodat er meer op kunnen verschijnen
een pagina en definieer ook de nieuwe opdrachten voor het zetten van de cxref-uitvoer.

(De bestandsnamen `cxref.tex' en `cxref.apdx.tex' zijn verschillend als de optie `-N' is
gebruikt.)

HTML uitgang
De standaard HTML-uitvoer is een bestand voor elk van de bronbestanden met één extra bestand
`cxref.html' dat elk van de andere bestanden bevat. Dit is om alleen een makefile mogelijk te maken
de gewijzigde bestanden bijwerken (hoewel de verwijzingen mogelijk vereisen dat alle bestanden
nogmaals gecontroleerd). Wanneer het cxref.html-bestand is geschreven, kan het door de gebruiker worden gewijzigd,
eventuele nieuwe bestanden die worden toegevoegd, worden aan het einde toegevoegd vóór de inhoudsopgave, de rest
dat het bestand ongewijzigd blijft.

De index wordt geschreven naar een bestand met de naam `cxref.apdx.html' en cxref.html wordt bijgewerkt om te verwijzen naar
aan.

(De bestandsnamen `cxref.html' en `cxref.apdx.html' zijn verschillend als de optie `-N' is
gebruikt.)

De HTML-uitvoer gebruikt de HTML 4.01-standaard en alle pagina's valideren correct.

RTF uitgang
Rich Text Format is een paginabeschrijvingsformaat op een vrij laag niveau, bedacht door Microsoft. Het
is geen goed gedefinieerde en gemakkelijk te begrijpen standaard zoals de andere formaten, maar dat is het wel
populair voor documentuitwisseling.

Er is één uitvoerbestand voor elk van de bronbestanden en een indexbestand.

SGML uitgang
Omdat SGML een metataal is, is het noodzakelijk om ook de lay-outelementen te definiëren
geef de informatie. De cxref-uitvoer gebruikt het LinuxDoc-documentformaat en is
ontworpen voor gebruik met de SGMLtools-programma's (http://www.sgmltools.org/).

Er is één uitvoerbestand voor elk van de bronbestanden en een indexbestand.

Gebruik cxref online met behulp van onworks.net-services