cxref - Online nel cloud

PROGRAMMA:

NOME

cxref - Strumento C Cross Reference & Documenting.

SINOSSI

cxrif Nome del file [ ... nome del file] [-Ocognome] [-Nnome di base] [-Rnome di base] [-tutti-commenti]
[-Non ci sono commenti] [-commenti-verbatim] [-blocca-commenti]
[-xref[-all][-file][-funz][-var][-tipo]] [-avvertire[-all][-commento][-xrif]]
[-index[-all][-file][-funz][-var][-tipo]] [-crudo] [-lattice] [-html[-origine]] [-rtf] [-sgml]
[-IOcognome] [-Ddefinire] [-Udefinire] [-CPP programma_cpp] [-- cpp_args ... cpp_args]

cxrif Nome del file [ ... nome del file] -Elimina [-Ocognome] [-Nnome di base] [-Rnome di base]

DESCRIZIONE

Un programma in grado di generare automaticamente documentazione e riferimenti incrociati per un C
.

L'input è un qualsiasi programma C con commenti appropriati e l'output è LaTeX, HTML, RTF o
file SGML.

VERSIONI

Nome del file
Il nome del file da documentare, qualsiasi numero di file può essere documentato alla volta.

-Elimina
I file nominati devono essere cancellati dalla directory di output e le loro voci in
il database di riferimento incrociato ei file di output principali devono essere rimossi.

-Odirnome
Il nome di una directory da utilizzare per i file latex di output e la posizione del
file di riferimento incrociato che vengono creati.

-Nnomebase
Il nome da utilizzare invece per la prima parte dei file di output e di riferimento incrociato
di cxref, le estensioni dei file rimangono le stesse.

-Rnome
Quando i file sorgente si trovano in più di una directory, imposta dirname al nome di
la directory radice dell'albero dei sorgenti (usa il percorso relativo se più facile, ad esempio `-R../ ..').
Questo eseguirà quindi cxref da quella directory radice e `-Odirname' deve essere
relativo a quella directory.

-tutti-commenti
Nel caso pensi che i commenti esistenti possano funzionare, (vedi sopra per la descrizione
di commenti speciali). [Pericolo! Questa opzione può produrre risultati strani.]

-Non ci sono commenti
Ignora tutti i commenti, utile se vuoi solo i riferimenti incrociati e non i
documentazione.

-commenti-verbatim
Quando i commenti che hai nel codice sono formattati in uno stile predeterminato
che vuoi preservare sull'output, questa opzione li costringerà a non essere
riformattato. [Nota, questo è solo per i commenti di file e funzioni.]

-block-commenti
Quando i commenti nel programma sono formattati nello stile "a blocchi" (con l'iniziale
carattere '*' su ogni riga), questa opzione rimuoverà quel carattere dal
produzione. [Funziona per un singolo `*', `+', `|' o `:' su ogni riga.]

-xrif Produrre informazioni sui riferimenti incrociati (vedi sotto).
-all Tutti i riferimenti incrociati.
-file Riferimenti incrociati per i file.
-func Riferimenti incrociati per le funzioni.
-var Riferimenti incrociati per le variabili.
-type Riferimenti incrociati per i tipi.

-avvisare Produrre avvisi, le opzioni devono essere concatenate tra loro:
-all Tutti gli avvisi.
-comment Avvisa dei commenti mancanti.
-xref Avvisa dei riferimenti incrociati mancanti.

-indice Produrre un indice di riferimento incrociato, le opzioni devono essere concatenate tra loro:
-all Tutti gli indici.
-file Indice dei file.
-func Indice delle funzioni.
-var Indice delle variabili.
-type Indice dei tipi.

-crudo Produrre una forma grezza di output, non molto utile se non con -warn.

-lattice Produci un file LaTeX per documentare ciascuno dei file sorgente e anche un file extra
che include ciascuno di questi file.

-html Produci un file HTML 4.01 per documentare ciascuno dei file sorgente e un file principale per
fare riferimento a ciascuno di questi file.

-src-html
Produci l'output HTML e una versione HTML del file sorgente con i link al suo interno.

-rtf Produci un file RTF (Rich Text Format) per documentare il file di origine.

-sgml Produrre un file SGML per documentare il file sorgente. (Utilizzando il LinuxDoc DTD).

-Cognome
Opzione GCC per specificare il percorso per i file di inclusione.

-Ddefinire
Opzione GCC per definire un simbolo del preprocessore.

-Udefinire
Opzione GCC per annullare la definizione di un simbolo di pre-processore.

-CPP Programma
Il nome del programma da utilizzare al posto dell'impostazione predefinita in fase di compilazione. Il programma
deve essere in grado di eseguire tutte le azioni che `gcc -E -C -dD' fa per funzionare. Se
il programma accetta argomenti, quindi l'intera cosa deve essere tra virgolette in modo che
viene interpretato come un singolo argomento per cxref.

--arg ... arg
Argomenti aggiuntivi da passare al preprocessore possono essere posizionati dopo `--'
separatore.

C Compiler Sostituzione cxref-cc
Per semplificare l'uso di cxref sul codice sorgente esistente, ora c'è uno script di shell che lo farà
chiamare il compilatore C e quindi chiamare cxref per elaborare il file sorgente. Questo significa che
può essere usato in sostituzione di CC in Makefile e simili.

Utilizzo: cxref-cc [solite opzioni cc]

Il nome del file sorgente viene estratto dall'elenco delle opzioni così come il `-D*',
`-I*', `-U*' e quando il compilatore C esce con successo verrà chiamato cxref. Il
il nome del compilatore C da utilizzare è controllato dalla variabile d'ambiente CXREFCC, o se
questo non è impostato quindi la variabile d'ambiente CC, o in mancanza di questo solo gcc.

L'uso di questo script richiede l'uso di un file di configurazione `.cxref' per contenere le opzioni
poiché non c'è nessun posto dove mettere le opzioni sulla riga di comando per il compilatore C.

Questo farà solo riferimento incrociato e documenterà i file sorgente C poiché sono gli unici
quelli che sono compilati, ma farà in modo che siano incrociati con il
opzioni corrette ecc.

Cxrif Configurazione Compila il
Questi argomenti della riga di comando possono anche essere inseriti in un file chiamato `.cxref' invece che su
riga di comando. Quando viene eseguito cxref, gli argomenti del programma vengono interpretati nel
seguendo l'ordine.

(1) Quelli sulla riga di comando. (2) Quelli nel file `.cxref' nella directory corrente.
(3) Quelli nel file `.cxref' nella radice dell'albero dei sorgenti specificata da `-R'.

Ciò significa che in un albero dei sorgenti multi-directory, ogni sottodirectory può avere un `.cxref'
file contenente solo la riga `-R..' o appropriato. La directory principale può avere un
File `.cxref' contenente il resto delle opzioni. Questo elimina completamente la necessità
per avere qualsiasi opzione sulla riga di comando oltre ai nomi dei file di origine.

Il formato del file `.cxref' è un qualsiasi numero di righe, ognuna contenente un singolo
argomento della riga di comando (equivalente a uno degli argv). Le uniche opzioni che non possono essere
usati sono i nomi dei file sorgente stessi e l'opzione `-delete'. Le righe vuote sono
ignorato e le righe che iniziano con un '#' sono commenti.

Programma Documentazione Commenti
La documentazione per il programma è prodotta da commenti nel codice che sono
opportunamente formattato. Il riferimento incrociato deriva dal codice stesso e non richiede
lavoro extra.

I commenti speciali sono `/**** ****/' (per un file) e `/*++++ ++++*/' (per un dato
oggetto) qualsiasi numero di `*' o `+' può essere utilizzato all'interno del commento standard `/*' e `*/'
delimitatori nei commenti, vengono ignorati.

Se una riga di commento inizia con uno spazio bianco ed è seguita da `+html+', il resto dei
la riga è inclusa solo nell'output HTML e non viene elaborata in modo che possa includere HTML
markup, `-html-' significa che il resto della riga è incluso in tutto tranne che nell'HTML
produzione. Lo stesso vale anche per gli altri formati di output, `+nessuno+' può essere usato per le linee
non apparire in nessun output. L'eccezione a questo è che l'output non elaborato non fa nulla
controllando e restituirà tutte le righe.

In ogni situazione in cui un commento segue un `,', `;' o `)' separati solo da spazi e
schede, il commento viene spostato prima della punteggiatura da applicare all'oggetto lì.

Il programma è implementato utilizzando un parser grammaticale ANSI C completo con alcune estensioni GCC,
questo significa che lo stile del codice non è importante, solo il contenuto ei commenti.

Cross Riferimenti
Il riferimento incrociato viene eseguito per i seguenti elementi

File
I file in cui è incluso il file corrente
(anche se incluso tramite altri file).

#include
File inclusi nel file corrente.
I file inclusi da questi file ecc.

Variabili
La posizione della definizione delle variabili esterne.
I file che hanno visibilità delle variabili globali.
I file/funzioni che utilizzano la variabile.

funzioni
Il file in cui è prototipata la funzione.
Le funzioni che la funzione chiama.
Le funzioni che chiamano la funzione.
I file e le funzioni che fanno riferimento alla funzione.
Le variabili utilizzate nella funzione.

Ciascuno di questi elementi viene incrociato nell'output.

Il riferimento incrociato utilizza i file `cxref.variable', `cxref.function', `cxref.include' e
`cxref.typedef' nella directory di output. Questi sono un elenco completo della funzione e
utilizzo variabile nel programma e potrebbe essere utilizzato per generare una gerarchia di chiamate di funzione o
diagramma di utilizzo variabile per esempio. Sono necessari due passaggi cxref di ciascun file, il primo per
costruire i file di riferimento incrociato e il secondo per usarli.

(I nomi dei file sono diversi se viene utilizzata l'opzione `-N'.)

LaTeX Uscita
L'output LaTeX predefinito è un file per ciascuno dei file sorgente con un file in più
`cxref.tex' che include ciascuno degli altri file. Questo serve per consentire solo a un makefile
aggiorna i file modificati (sebbene i riferimenti possano richiedere che tutti i file siano
ricontrollato). Quando il file cxref.tex è stato scritto può essere modificato dall'utente,
tutti i nuovi file che vengono aggiunti vengono aggiunti alla fine della sezione del codice sorgente, il resto di
il file rimane invariato.

L'indice viene scritto in un file chiamato `cxref.apdx.tex' e cxref.tex viene aggiornato per fare riferimento
ad esso.

Sono stati inoltre scritti tre file di stile LaTeX `page.sty', `fonts.sty' e `cxref.sty'.
Questi impostano la pagina per utilizzare un margine più piccolo e caratteri più piccoli per consentire la visualizzazione di più elementi
una pagina e definire anche i nuovi comandi per la composizione dell'output del cxref.

(I nomi dei file `cxref.tex' e `cxref.apdx.tex' sono diversi se l'opzione `-N' è
Usato.)

HTML Uscita
L'output HTML predefinito è un file per ciascuno dei file sorgente con un file in più
`cxref.html' che include ciascuno degli altri file. Questo serve per consentire solo a un makefile
aggiorna i file modificati (sebbene i riferimenti possano richiedere che tutti i file siano
ricontrollato). Quando il file cxref.html è stato scritto può essere modificato dall'utente,
tutti i nuovi file che vengono aggiunti vengono aggiunti alla fine prima del sommario, il resto
del file rimanendo invariato.

L'indice viene scritto in un file chiamato `cxref.apdx.html' e cxref.html viene aggiornato per fare riferimento
ad esso.

(I nomi dei file `cxref.html' e `cxref.apdx.html' sono diversi se l'opzione `-N' è
Usato.)

L'output HTML utilizza lo standard HTML 4.01 e tutte le pagine vengono convalidate correttamente.

RTF Uscita
Rich Text Format è un formato di descrizione della pagina di livello piuttosto basso ideato da Microsoft. Esso
non è uno standard ben definito e di facile comprensione come lo sono gli altri formati, ma lo è
popolare per lo scambio di documenti.

C'è un singolo file di output per ciascuno dei file di origine e un file di indice.

SGML Uscita
Poiché SGML è un metalinguaggio è necessario definire anche gli elementi del layout
fornire le informazioni. L'output di cxref utilizza il formato del documento LinuxDoc ed è
progettato per l'uso con i programmi SGMLtools (http://www.sgmltools.org/).

C'è un singolo file di output per ciascuno dei file di origine e un file di indice.

Usa cxref online utilizzando i servizi onworks.net