autogsdoc - Online nel cloud

PROGRAMMA:

NOME

autogsdoc - generatore di documentazione API GNUstep e convertitore XML->HTML

SINOSSI

autogsdoc [-File Nome del file] [-GeneraHtml S|no] [-Pulire si|NO] [-Pulisci modelli
si|NO] [-Ignora Dipendenze si|NO] [-Crea Dipendenze si|NO] [-Mostra Dipendenze si|NO]
[-Directory di intestazione sentiero] [-Directory Documentazione sentiero] [-Dichiarato località] [-Progetto
titolo] [-Standard si|NO] [-DocumentAllInstanceVariables si|NO]
[-Variabili di istanza di documento S|no] [-VariabiliIstanzaAtEnd si|NO] [-CostantiModello
Nome del file] [-FunzioniModello Nome del file] [-MacroModello Nome del file] [-TypedefsModello
Nome del file] [-VariabiliModello Nome del file] [-Progetti di sistema stringa] [-Progetti Locali stringa]
[-Progetti dictString] [-Verboso si|NO] [-Avvisare si|NO] [-Mappa di parole dictString] [file]

DESCRIZIONE

Lo strumento autogsdoc è un'utilità della riga di comando che aiuta gli sviluppatori a produrre riferimenti
documentazione per le API GNUstep. Consente inoltre agli sviluppatori di scrivere e gestire altri
documentazione in XML e convertirla in HTML. In dettaglio, autogsdoc:

- Estrarre commenti speciali che descrivono le interfacce pubbliche di classi, categorie,
protocolli, funzioni e macro dal codice sorgente Objective C (file di intestazione e
facoltativamente file sorgente) in file XML GSDoc.

- Converti file XML GSDoc, generati dal codice sorgente o scritti manualmente da
sviluppatori, in HTML.

- Costruisci indici basati su set di file XML GSDoc e convertili anche in HTML.

L'uso più comune è eseguire il comando con uno o più nomi di file di intestazione come
argomenti ... lo strumento analizzerà automaticamente i file sorgente corrispondenti nello stesso
directory come le intestazioni (o la directory corrente, o la directory specificata usando il tasto
DocumentationDirectory predefinito) e produce file GSDoc e HTML come output. Per meglio
risultati questa modalità dovrebbe essere eseguita dalla directory contenente i file di origine. (Nota
che poiché C è un sottoinsieme dell'Obiettivo C, questo strumento può operare per documentare funzioni e
altre strutture C in sorgente C normale.)

I file GSDoc possono anche essere forniti direttamente in aggiunta o da soli e verranno convertiti
all'HTML. Vedere la documentazione HTML di GSDoc o il gsdoc(7) pagina man per informazioni sul
formato GSDoc.

Infine, i file HTML possono essere dati sulla riga di comando. Riferimenti incrociati ad altre parti di
la documentazione del codice trovata al loro interno verrà riscritta in base a ciò che si trova nel
progetto attualmente.

FONTE CODICE MARCATURA

Il parser del codice sorgente produrrà automaticamente documenti GSDoc che elencano i metodi in
le classi trovate nei file sorgente e includerà il testo appositamente formattato
commenti dai file di origine.

Qualsiasi commento che inizia con barra e Tutto asterischi al posto della comune barra e del singolo
asterisco, è considerato markup GSDoc, da utilizzare come descrizione della classe o del metodo
seguendolo. Questo testo di commento viene riformattato e quindi inserito nell'output.
Quando più commenti sono associati allo stesso elemento, vengono uniti insieme con a
interruzione di linea ( ) tra ciascuno, se necessario.

Lo strumento può essere facilmente utilizzato per documentare programmi e librerie, semplicemente fornendolo
il nome del file sorgente contenente la funzione main() del programma - prende il
commenti speciali da quella funzione e li gestisce in modo speciale, inserendoli come a
sezione alla fine del primo capitolo del documento (crea il primo capitolo se
necessario).

Opzioni sono descritti nella sezione argomenti e Impostazioni predefinite qua sotto.

EXTRA MARCATURA

Ci sono alcuni casi in cui vengono eseguite lavorazioni extra speciali, prevalentemente nel
primo commento trovato nel file sorgente, da cui possono essere vari pezzi di markup GSDoc
estratti e collocati in posizioni appropriate nel documento di output -

Autogsdoc Fonte:
In ogni riga dove Autogsdoc Fonte: è trovato, il resto della linea è preso come a
nome del file sorgente da utilizzare invece di presumere che ogni file .h
processato utilizza un file .m con lo stesso nome. Puoi fornirne più di uno Autogsdoc Fonte:
righe in cui un file di intestazione dichiara elementi definiti in più file di origine.
Se il nome di un file è assoluto, viene utilizzato come fornito. Se d'altra parte, è un
percorso relativo, il software cerca prima il file sorgente rispetto alla posizione
del file di intestazione e, se non vi si trova, relativo alla directory corrente in cui
autogsdoc è in esecuzione, e infine relativo alla directory specificata dal
Documentazione Directory predefinito.


Un abstract del contenuto del documento... posto in testa all'output di GSDoc.


Una descrizione dell'autore del codice - può essere ripetuta per gestire il caso in cui a
documento ha più autori. Posto in testa all'uscita GSDoc. Come aiuto a
leggibilità della fonte, vengono eseguite alcune elaborazioni aggiuntive speciali relative a
l'autore del documento - Qualsiasi riga del modulo "Autore: nome" ', o 'Da:
nome ', o 'Autore: nome' o 'Per: nome' verranno riconosciuti e
convertito in an autore elemento, possibilmente contenente an email elemento.


Inserito nell'output di GSDoc appena prima della fine del corpo del documento - previsto
da utilizzare per appendici, indice ecc..


Posto immediatamente prima di qualsiasi documentazione di classe generata ... destinata ad essere utilizzata
per fornire una descrizione generale di come funziona il codice che viene documentato. Qualunque
la documentazione per la funzione main() di un programma è inserita come sezione alla fine
di questo capitolo.


Copyright del contenuto del documento ... posto in testa all'output di GSDoc.
Per facilitare la leggibilità della fonte, è necessaria una speciale elaborazione aggiuntiva
eseguito - Qualsiasi riga del modulo "Testo del copyright (C)" verrà riconosciuta e convertita
ad un copia elemento.


Data della revisione del documento ... posta in testa all'output del GSDoc. Se
questo viene omesso lo strumento proverà a costruire un valore dal tag RCS Date (se
a disposizione).


Inserito nel documento all'inizio del corpo ... destinato a prevedere
introduzione o pagine di contenuto ecc.


Titolo del documento ... posto in testa all'output di GSDoc. Se questo viene omesso
lo strumento genererà un titolo (probabilmente scarso) a sé stante, quindi dovresti includerlo
markup manualmente.


Identificativo della versione del documento ... posto in testa all'output di GSDoc. Se
questo viene omesso lo strumento proverà a costruire un valore dal tag RCS Revision (se
a disposizione).

NB Il markup appena descritto può essere utilizzato all'interno della documentazione di classe, categoria o protocollo
... in caso affermativo, viene estratto e avvolto nel resto della documentazione per la classe
come il capitolo della classe. Il resto della documentazione della classe viene normalmente inserita al
fine del capitolo, ma può invece essere sostituito al posto del pseudo-
elemento all'interno del elemento.

METODO MARCATURA

Nei commenti utilizzati per fornire testo per una descrizione del metodo, il seguente markup è
rimosso dal testo e trattato in modo speciale -


Il metodo è contrassegnato come l'inizializzatore designato per la classe.


Il metodo è contrassegnato come uno di cui le sottoclassi devono sovrascrivere (ad esempio un abstract
metodo).


Il metodo è contrassegnato come uno che le sottoclassi dovrebbero NON oltrepassare.


Il markup viene rimosso dalla descrizione e posizionato dopo nell'output di GSDoc -
in modo che il metodo sia descritto come conforme (o non conforme) a quanto specificato
standard.

AUTOMATICI MARCATURA

Generalmente, il testo nei commenti viene riformattato per standardizzarlo e far rientrare bene... il
la riformattazione è non è un eseguita su qualsiasi testo all'interno di an elemento. Quando il testo è
riformattato, viene suddiviso in "parole" separate da spazi che vengono poi sottoposte a
qualche elaborazione in più...

Alcune costanti ben note come YES, NO e nil sono racchiuse tra ...
markup.

I nomi degli argomenti dei metodi all'interno delle descrizioni dei metodi sono racchiusi tra ...
</ var> marcatura.

I nomi dei metodi (che iniziano con un più o un meno) sono racchiusi tra ...
markup. Ad esempio, "-init" (senza virgolette) sarebbe racchiuso in un riferimento GSDoc
elemento per puntare al metodo init della classe corrente o, se solo una classe nota
avesse un metodo init, farebbe riferimento al metodo di quella classe. Nota il fatto che
il nome del metodo deve essere circondato da spazi per essere riconosciuto (sebbene una virgola,
punto o punto e virgola alla fine dell'identificatore agirà come uno spazio bianco).

Identificatori del metodo inclusi i nomi delle classi (che iniziano e finiscono con parentesi quadre)
sono racchiusi in ... markup. ad esempio '[NSObject-init]', creerà a
riferimento al metodo init di NSObject (o la classe propriamente detta, o una delle sue
categorie), mentre '[(NSCopying)-copyWithZone:]', crea un riferimento a un metodo in
il protocollo NSCopying. Nota che non devono apparire spazi tra le parentesi quadre
in questi specificatori. I nomi dei protocolli sono racchiusi tra parentesi tonde anziché tra
le consuete parentesi angolari, perché GSDoc è un linguaggio XML e XML tratta l'angolo
parentesi appositamente.

I nomi delle funzioni (che terminano con '()') diversi da 'main()' sono racchiusi tra ...
markup. Ad esempio, "NSLogv()" (senza virgolette) sarebbe racchiuso in un GSDoc
elemento di riferimento per puntare alla documentazione della funzione NSLog. Nota il fatto
che il nome della funzione deve essere circondato da spazi (sebbene una virgola, un punto o
il punto e virgola alla fine dell'identificatore fungerà anche da terminatore di spazi bianchi).

ARGOMENTI E DEFAULT

Lo strumento accetta determinate impostazioni predefinite dell'utente (che possono ovviamente essere fornite come riga di comando
argomenti anteponendo '-' prima del nome predefinito e dando il valore in seguito, come in
-Pulito SI):

Pulizia
Se questo valore booleano è impostato su YES, invece di generare documentazione, il
lo strumento rimuove tutti i file GSDoc generati nel progetto e tutti i file html generati
da loro (così come quelli generati dai file GSDoc elencati
esplicitamente) e infine rimuove il file di indice del progetto. L'unica eccezione a questo
è quel modello di file GSDoc (cioè quelli specificati usando "-ConstantsTemplate ...",
Gli argomenti "-FunctionsTemplate ..." ecc.) non vengono eliminati a meno che non vengano eliminati i CleanTemplates
bandiera è impostata.

Pulisci modelli
Questo flag specifica se i file modello GSDoc devono essere rimossi insieme ad altri
file quando è specificata l'opzione Pulisci. L'impostazione predefinita è che non vengano rimossi
... poiché questi modelli potrebbero essere stati prodotti manualmente e avevano solo dati inseriti
in loro.

CostantiModello
Specificare il nome di un documento modello in cui inserire la documentazione sulle costanti
dovrebbe essere inserito da tutti i file nel progetto. Questo è utile se le costanti nel
il codice sorgente è sparpagliato in molti file e devi raggrupparli in uno
luogo. Sei responsabile di garantire che il documento modello di base (in cui
viene inserita una documentazione costante individuale) contiene tutte le altre informazioni che
vuoi, ma per comodità autogsdoc genererà un semplice modello (che potresti
quindi modifica) per te se il file non esiste. L'inserimento avviene immediatamente
prima di precedente elemento (o se non esiste, immediatamente prima della fine del
stile di vita elemento) nel modello.

Dichiarato
Specificare dove devono essere documentate le intestazioni quando vengono trovate. Il vero nome prodotto
nella documentazione è formato aggiungendo l'ultimo componente del nome del file di intestazione
al valore di questo default. Se questo valore predefinito non è specificato, il nome completo del
file di intestazione (come fornito sulla riga di comando), con l'impostazione predefinita HeaderDirectory
anteposto, viene utilizzato. Un uso tipico di questo potrebbe essere '"Fondazione dichiarata"' quando
generazione di documentazione per la libreria di base GNUstep. Ciò comporterebbe il
documentazione che dice che NSString è dichiarato in 'Foundation/NSString.h'

DocumentAllInstanceVariables
Questo flag consente di generare la documentazione per tutte le variabili di istanza. Normalmente,
verranno documentati solo quelli esplicitamente dichiarati 'pubblici' o 'protetti'.

Variabili di istanza documento
Questo flag consente di disattivare completamente la documentazione per le variabili di esempio.
Normalmente, le variabili di istanza dichiarate esplicitamente "pubbliche" o "protette" saranno
Documentati.

Variabili Istanza Alla Fine
Questo flag, se impostato, indica al generatore HTML di posizionare la documentazione della variabile di istanza
alla fine della lezione, invece che all'inizio. Questo è utile se usi molto
variabili di istanza protette che saranno solo di interesse secondario per
utenti generici della classe.

Documentazione Directory
Può essere utilizzato per specificare la directory in cui deve essere collocata la documentazione generata.
Se questo non è impostato, l'output viene posizionato nella directory corrente. Questa directory è anche
utilizzato come ultima risorsa per individuare i file di origine (non le intestazioni) e, cosa più importante,
è usato come prima di tutto e esclusivamente ricorrere per individuare eventuali file .gsdoc che vengono passati su
la riga di comando. Qualsiasi informazione sul percorso fornita per questi file è rimosso e loro sono
cercato in 'DocumentationDirectory' (anche se potrebbero non essere stati
autogenerato).

File
Specifica il nome di un file contenente un elenco di nomi di file come array di elenchi di proprietà
(nome1,nome2,...) formato. Se è presente, i nomi dei file nell'elenco degli argomenti del programma
vengono ignorati e i nomi in questo file vengono utilizzati come elenco di nomi da elaborare.

FunzioniModello
Specificare il nome di un documento modello in cui inserire la documentazione sulle funzioni
dovrebbe essere inserito da tutti i file nel progetto. Questo è utile se la funzione source
il codice è sparso in molti file ed è necessario raggrupparlo in un'unica posizione. Siete
responsabile di garantire che il documento modello di base (in cui l'individuo
è inserita la documentazione della funzione) contiene tutte le altre informazioni desiderate, ma
per comodità autogsdoc genererà un semplice modello (che potrai poi modificare)
per te se il file non esiste. L'inserimento avviene immediatamente prima del precedente
elemento (o se non esiste, immediatamente prima della fine del stile di vita elemento) in
Il template.

Genera HTML
Può essere utilizzato per specificare se deve essere generato un output HTML. L'impostazione predefinita è S.

Intestazione Directory
Può essere utilizzato per specificare la directory in cui cercare i file di intestazione. Quando fornito,
questo valore è anteposto ai relativi nomi di intestazione, altrimenti i relativi nomi di intestazione
vengono interpretati rispetto alla directory corrente. File di intestazione specificati come assoluti
i percorsi non sono influenzati da questa impostazione predefinita.

Ignora Dipendenze
Un valore booleano che può essere usato per specificare che il programma deve ignorare il file
tempi di modifica e rigenerare comunque i file. Previsto per l'uso in combinazione con
il sistema 'make', che dovrebbe gestire autonomamente il controllo delle dipendenze.

Progetti Locali
Questo valore viene utilizzato per controllare l'inclusione automatica di progetti esterni locali in
il sistema di indicizzazione per la generazione dei riferimenti incrociati nell'output del documento finale. Se
impostato su 'Nessuno', non vengono eseguiti riferimenti al progetto locale, in caso contrario, il 'Locale'
La directory della documentazione di GNUstep viene cercata in modo ricorsivo per i file con un '.igsdoc'
estensione e vengono utilizzate le informazioni di indicizzazione di quei file. Il valore di questo
stringa viene anche utilizzata per generare i nomi dei file nel riferimento incrociato ... se è an
stringa vuota, si presume che il percorso da utilizzare sia un file nella stessa directory in cui
igsdoc è stato trovato, altrimenti viene utilizzato come prefisso al nome nell'indice. NB.
I progetti locali con lo stesso nome del progetto attualmente in fase di documentazione lo faranno non è un
essere inclusi da questo meccanismo. Se desideri includere tali progetti, devi farlo
usando esplicitamente -Progetti ...

MacroModello
Specificare il nome di un documento modello in cui dovrebbe essere inserita la documentazione sulle macro
essere inserito da tutti i file del progetto. Questo è utile se il codice macro è sparso
intorno a molti file e devi raggrupparli in un unico posto. Sei responsabile di
assicurando che il documento modello di base (in cui la documentazione macro individuale
è inserito) contiene tutte le altre informazioni desiderate, ma per comodità
autogsdoc genererà un semplice modello (che puoi quindi modificare) per te se il
il file non esiste. L'inserimento avviene immediatamente prima del precedente elemento (o se
che non esiste, immediatamente prima della fine del stile di vita
elemento) nel modello.

Crea Dipendenze
Un nome file da utilizzare per generare informazioni sulle dipendenze per make. Questo richiederà
forma di elenco di tutti i file di intestazione e sorgente noti per il progetto come dipendenze di
il nome del progetto (vedi 'Progetto').

Progetto
Può essere usato per specificare il nome di questo progetto... determina il nome dell'indice
file di riferimento prodotto come parte della documentazione per fornire informazioni abilitanti
altri progetti per fare riferimento agli elementi di questo progetto.

Progetti
Questo valore può essere fornito come un dizionario contenente i percorsi di igsdoc
file di indice/riferimento utilizzati da progetti esterni, insieme ai valori da utilizzare per la mappatura
i nomi dei file trovati negli indici. Ad esempio, se un file di indice del progetto (igsdoc)
dice che la classe "Foo" si trova nel file "Foo" e il percorso associato a
quell'indice del progetto è '/usr/share/doc/proj', quindi l'output html generato può fare riferimento
la classe come in '/usr/share/doc/prj/Foo.html' . Nota che un dizionario potrebbe essere
fornito sulla riga di comando utilizzando il formato PropertyList standard (non XML
formato di OS X), utilizzando il punto e virgola come separatore di riga e racchiudendolo in un unico
citazioni.

Mostra Dipendenze
Un valore booleano che può essere utilizzato per specificare che il programma deve registrare quali file
vengono rigenerati a causa delle loro dipendenze da altri file.

Internazionali
Un valore booleano utilizzato per specificare se il programma deve inserire informazioni su
conformità agli standard nella documentazione. Questo dovrebbe essere usato solo quando
documentando le librerie e gli strumenti GNUstep stessi in quanto presuppone che il codice
essere documentato fa parte di GNUstep e possibilmente è conforme allo standard OpenStep
o implementa metodi compatibili con MacOS-X.

Progetti di sistema
Questo valore viene utilizzato per controllare l'inclusione automatica di progetti esterni al sistema in
il sistema di indicizzazione per la generazione dei riferimenti incrociati nell'output del documento finale. Se
impostato su 'Nessuno', non vengono eseguiti riferimenti al progetto di sistema, altrimenti il ​​'Sistema'
La directory della documentazione di GNUstep viene cercata in modo ricorsivo per i file con un '.igsdoc'
estensione e vengono utilizzate le informazioni di indicizzazione di quei file. Il valore di questo
stringa viene anche utilizzata per generare i nomi dei file nel riferimento incrociato ... se è an
stringa vuota, si presume che il percorso da utilizzare sia un file nella stessa directory in cui
igsdoc è stato trovato, altrimenti viene utilizzato come prefisso al nome nell'indice. NB.
I progetti di sistema con lo stesso nome del progetto attualmente in fase di documentazione saranno non è un
essere inclusi da questo meccanismo. Se desideri includere tali progetti, devi farlo
usando esplicitamente -Progetti ...

TypedefsModello
Specificare il nome di un documento modello in cui dovrebbe essere inserita la documentazione sui typedef
essere inserito da tutti i file del progetto. Questo è utile se il codice sorgente typedef è
sparsi in molti file e devi raggrupparli in un unico posto. Siete
responsabile di garantire che il documento modello di base (in cui l'individuo
typedef è inserita) contiene tutte le altre informazioni desiderate, ma come
un comodo autogsdoc genererà un semplice modello (che puoi quindi modificare) per
se il file non esiste. L'inserimento avviene immediatamente prima del precedente
elemento (o se non esiste, immediatamente prima della fine del stile di vita elemento) in
Il template.

Up Una stringa utilizzata per fornire il nome da utilizzare nel collegamento 'up' dal GSDoc generato
documenti. Questo dovrebbe normalmente essere il nome di un file che contiene un indice del
contenuto di un progetto. Se questo manca o è impostato su una stringa vuota, non "su"
il collegamento sarà fornito nei documenti.

VariabiliModello
Specificare il nome di un documento modello in cui inserire la documentazione sulle variabili
dovrebbe essere inserito da tutti i file nel progetto. Questo è utile se sorgente variabile
il codice è sparso in molti file ed è necessario raggrupparlo in un'unica posizione. Siete
responsabile di garantire che il documento modello di base (in cui l'individuo
viene inserita la documentazione variabile) contiene tutte le altre informazioni desiderate, ma
per comodità autogsdoc genererà un semplice modello (che potrai poi modificare)
per te se il file non esiste. L'inserimento avviene immediatamente prima del precedente
elemento (o se non esiste, immediatamente prima della fine del stile di vita elemento) in
Il template.

verboso
Un booleano utilizzato per specificare se si desidera che l'output di debug/avviso dettagliato sia
prodotta.

Dai un avvertimento
Un booleano utilizzato per specificare se si desidera un output di avviso standard (ad es. rapporto di
metodi non documentati) prodotti.

Mappa delle parole
Questo valore è un dizionario utilizzato per mappare identificatori/parole chiave trovati nei file sorgente
ad altre parole. Generalmente non dovrai usarlo, ma a volte è utile
per evitare che il parser venga confuso dall'uso delle macro del preprocessore C. Puoi
ridefinire efficacemente la macro in qualcosa di meno confuso. Il valore si mappa il
l'identificatore deve essere uno tra - Un altro identificatore, Una stringa vuota - il valore è
ignorato, Due barre ('//') - il resto della riga viene ignorato. Nota che un dizionario
può essere fornito sulla riga di comando utilizzando il formato PropertyList standard (non il
formato XML di OS X), utilizzando il punto e virgola come separatore di riga e racchiudendolo in un unico
citazioni.

INTER-DOCUMENTI COLLEGAMENTO

L'impostazione predefinita 'Su' è usata per specificare il nome di un documento che dovrebbe essere usato come
collegamento 'up' per qualsiasi altro documento utilizzato. Questo nome non deve includere un percorso o un'estensione.
In genere, il documento a cui fa riferimento questa impostazione predefinita dovrebbe essere un documento GSDoc modificato manualmente
che dovrebbe avere una sezione posteriore contenente un indice di progetto. per esempio


<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.3//EN"
"http://www.gnustep.org/gsdoc-1_0_3.xml">


Il mio progetto di riferimento




Il mio progetto di riferimento

Usa autogsdoc online utilizzando i servizi onworks.net