COPYRIGHT doc - Copyright by Alberto Bellina (C) 1993-2001

PROJECT Documentazione

NAME

NAME : doc.c COPYRIGHT : doc - Copyright by Alberto Bellina (C) 1993-2001 PROJECT : Documentazione AREA : DOC LANGUAGE : C

DESCRIPTION

"doc" e' un estrattore di commenti da sorgenti 'C'. I commenti devono, per essere estratti, essere inseriti in header standardizzati (vedi documento "Standard di Programmazione" codice C-UNX/GNR/..../MQ). Esiste un header particolare per ciascuno di questi casi: - modulo - funzione - struttura dati - commento libero

NOTES

input file e output file devono essere diversi

BUGS

nessuno conosciuto

CHANGES

BEL xx.xx.92 Prima Stesura BEL 16.04.93 Porting su Unix con comiplazione non-ANSI BEL 30.08.94 Aggiunto formattazione per "nroff -man" con opzione -n BEL 27.09.94 Aggiornato agli standard di documentazione SIA BEL 04.11.94 Help in inglese inserito opzione -F per file multipli BEL 14.11.94 1.4b Aggiunto DEPENDENCIES in funzione BEL 23.12.94 1.5 Aggiunto gestione hypertext per Mosaic BEL 11.01.95 1.6 Corretto generazione link per Mosaic Generazione HTML da qualsiasi file BEL 02.08.95 1.7 Corretto gestione key LIBRARY SEE ALSO : man extractdoc prova - estrattore documentazione standard

DESCRIPTION

Doc esamina il sorgente selezionato e, se ne trova, estrae i commenti rilevati.

RETURN VALUES

1 errore nell'apertura di un file 0 nessun errore

WARNINGS

Non usare input_file uguale output_file. doc - estrattore documentazione standard doc [-f|-m|-s|-a] [-n] [-H] [-p] [-i filesorgente] [-o filedoc] -f documenta solo funzioni -m documenta solo moduli -s documenta solo strutture dati -a documenta moduli,funzioni,strutture dati -n output preparato per 'nroff -man' -H output preparato mosaic -i file sorgente -o file destinazione documentazione -p stampa a video gli header standard utilizzati

DESCRIPTION

Doc esamina il sorgente selezionato e, se ne trova, estrae i commenti rilevati. La documentazione estratta viene formattata in stile-Unix (vedi documentazione (3) della manualistica). Utilizzando l'opzione -n il file di documentazione contiene i comandi per la formattazione utilizzata da "nroff" nell'utilizzo di man(1). Sono possibili vari tipi di utilizzo di doc: interattivo: doc linea di comando: doc [-f|-m|-s|-a] [-n] [-H] -i filein -o fileout Mediante le opzioni -i e -o e' possibile selezionare il file di in input e il file di output della documentazione. Le opzioni -f -m -s -a servono a selezionare quali tipi di documentazione si desidera estrarre: -f .. estrae documentazione delle funzioni -m .. estrae documentazione del modulo -s .. estrae documentazione delle strutture dati -a .. estrae documentazione di modulo,funzioni,strutture dati E' possibile stampare gli header utilizzando l'opzione -p. Mediante l'opzione -h e' possibile avere un semplice help. Doc non modifica in alcun modo il sorgente in esame. Per una perfetta formattazione della documentazione estratta si deve rispettare alcune semplici regole durante la scrittura. Le linee vengono automaticamente unite da nroff, anche se a capo riga, per esempio: ... Questa linea. Viene unita a questa. ... In uscita sulla documentazione sara' presentato: Questa linea. Viene unita a questa. Per evitare questo problema si deve scrivere in maniera "ben formattata", cioe' indentare tutti i caporiga di almento uno spazio, per es: Questa e' la prima linea .... seguita da questa seconda linea. Questa e' una nuova linea. In questo caso sara' mantenuto l'aspetto anche nella documentazione.

RETURN VALUES

1 errore nell'apertura di un file 0 nessun errore

WARNINGS

Non usare input_file uguale output_file.
Designed by Alberto Bellina
HOME