adabrowse - Online nel cloud

PROGRAMMA:

NOME

adabrowse - Genera un rendering HTML completamente incrociato delle specifiche Ada 95

SINOSSI

ad sfogliare [opzioni] -f filetto

DESCRIZIONE

ad sfogliare produce un rendering HTML completamente incrociato delle specifiche Ada 95 (senza corpi)
simile a ciò che fa javadoc per le sorgenti Java. ad sfogliare è un'utilità della riga di comando; ha
nessuna interfaccia utente grafica.

ad sfogliare è altamente configurabile tramite opzioni della riga di comando, fogli di stile e
file di configurazione.

ad sfogliare smonta completamente il codice sorgente e produce una documentazione HTML
contenente:
· Tutte le clausole contestuali
· Intestazione unità
· Se l'unità è un pacco:
— Tutte le eccezioni (incluse le rinomine)
— Tutte le costanti
— Tutte le variabili
— Un indice di tipo contenente tutti i tipi e le loro operazioni primitive (queste ultime solo
per i tipi di record (taggati), i tipi privati ​​e i tipi derivati ​​da questi).
l'elenco delle operazioni primitive è completamente referenziato e ordinato in base alle nuove definizioni,
operazioni sovrascritte ed ereditate.
— Altri articoli

USO

Ci sono due modi di usare ad sfogliare:

1. Chiamata ad sfogliare per le tue specifiche: ad sfogliare -f filetto (e qualsiasi altra opzione, se necessario, in
particolare -I se il file non si trova nella directory corrente o dipende da altre unità
le cui fonti non sono nella directory corrente!) Se non esiste alcun file albero per l'unità specificata
esiste, ad sfogliare proverò a generarne uno.

or

1. Generare i file ad albero per le specifiche che si desidera elaborare chiamando gnatgcc -c -gnatc
-gnatt filetto (con l'appropriato -I opzioni, se necessario.)

2. Chiamata ad sfogliare per queste specifiche: ad sfogliare -f filetto (e qualsiasi altra opzione, se necessario
[guarda in particolare -T!]).

ad sfogliare genera file HTML per impostazione predefinita nella directory corrente.

ad sfogliare non importa se i file dell'albero sono stati prodotti da specifiche o corpi:
poiché il file ad albero di un corpo contiene sempre anche le informazioni sulla specifica, può
lavorare con entrambi.

VERSIONI

-h, -?, -Aiuto, --Aiuto
Scrive un testo di aiuto completo.

-a, -tutti, --tutti
Genera HTML non solo per l'unità indicata nell'opzione -f, ma anche per tutte
unità applicative da cui dipende semanticamente (chiusura transitiva di "con"
e unità genitori).

Si noti che questa opzione elabora solo le unità applicative in modalità transitiva
chiusura anche se viene fornita anche l'opzione "-g"; non elabora alcun "with"ed
unità di libreria standard. Ciò significa anche che se l'unità data è una libreria standard
unità, l'opzione "-all" non ha alcun effetto. Questo comportamento è intenzionale:
normalmente generano HTML per la libreria standard una volta elaborando tutti gli standard
unità di libreria in modo esplicito e non si desidera rigenerare l'HTML per queste unità
ogni volta che una delle unità della tua applicazione "con" un'unità della libreria standard.

-c filetto
Definisce un file di configurazione per il generatore HTML. Multiplo -c le opzioni possono essere
dato; i file vengono elaborati nell'ordine indicato e potrebbero sovrascrivere la configurazione precedente
e socievole.

-f filetto
Fornisce il nome del file (*.ads) della specifica da elaborare. Questo nome del file può contenere un
percorso! Vedi sotto per altri commenti. Solo uno -f può essere data un'opzione.

-g Se impostato, ad sfogliare genera anche riferimenti incrociati ad elementi provenienti da unità di biblioteca in
i pacchetti standard e run-time, ad eccezione degli elementi del pacchetto implicito
"Standard". Nota: può essere impostato anche tramite una chiave del file di configurazione
"Refs_To_Standard". Vince la seconda definizione.

-G formati_output...
Specificare i formati di output ad sfogliare genererà. Il -G l'opzione deve essere seguita
da uno o più nomi di formato di output, forniti come argomenti separati. Output riconosciuto
i nomi dei formati sono html e xml (senza distinzione tra maiuscole e minuscole).

-i [filetto]
Se impostato, ad sfogliare genererà un indice del pacchetto se viene eseguito in "modalità di input file"
(vedi sotto) o il -tutti l'opzione è impostata e l'output non va su stdout.

Se viene fornito un nome di file, l'indice viene scritto in quel file (o in stdout, se il
il nome del file è "-").

-è [filetto]
Uguale a -i, ma genera un indice utilizzando l'indentazione per le unità figlio.

-l Make ad sfogliare generare riferimenti incrociati nell'output HTML utilizzando solo il numero di riga.
Questo è ciò che le versioni precedenti di ad sfogliare (fino alla versione V2.13 inclusa) lo ha sempre fatto.
A partire dalla versione V3.0, i riferimenti incrociati vengono costruiti tenendo conto sia della linea che
numero di colonna di un elemento. Dovresti usare questa opzione solo se hai HTML
documentazione generata in precedenza ad sfogliare versioni e in qualche modo non possono ri-
generare tale documentazione. Tuttavia, l'uso consigliato è di non utilizzare mai questo
opzione e per rigenerare la documentazione HTML eventualmente già esistente.

Nota che l'HTML generato con -l non è compatibile con HTML generato senza -l!
Inoltre, HTML generato da ad sfogliare 3.0 e versioni successive sono compatibili con HTML generato
by ad sfogliare 2.13 e precedenti solo se il -l l'opzione è data.

L'utilizzo di questa opzione genera un messaggio di avviso su stderr.

-o [filetto]
Definire il nome del file di output. Se non impostato, l'output va a un file con il nome di
l'input e il suffisso .html. Se filetto specifica una directory (ad esempio, termina con "\" su
Windows o "/" su Unix), tutti i file HTML generati verranno inseriti in tale
directory. Se il nome del file è "-", l'output viene scritto su stdout. Solo una -o opzione
può essere dato.

Un trattino come nome file ("-") è consentito solo se esiste esattamente un formato di output
specificato. Se sono specificati più formati di output (ad esempio sia XML che HTML),
l'output non può andare su stdout.

-p [filetto]
As -i, ma genera un indice di sottoprogramma su tutte le unità elaborate.

-privato, --privato
Se dato, ad sfogliare elaborerà anche le parti private dei pacchetti e delle attività o
dichiarazioni protette. (Per impostazione predefinita, non lo fa ma sostituisce le dichiarazioni private
parti con un commento che dice "Implementazione definita".)

-q Modalità silenziosa: non emettere messaggi di avviso o informativi. Sinonimo di -w0.

-s URL Definisce l'URL del foglio di stile che il file HTML generato dovrà utilizzare. Questo URL
dovrebbe essere relativo al posto finale in cui inserirai i file HTML! Nota che
a -s l'opzione può essere sovrascritta da una successiva -c opzione, se il file di configurazione
definisce la chiave "Style_Sheet".

-t [filetto]
As -i, ma genera un indice di tipo globale su tutte le unità elaborate.

-versione, --versione
Informazioni sulla versione di stampa di ad sfogliare a stderr.

-wi Imposta il livello di avviso di ad sfogliare. i può essere uno dei seguenti:
0 oppure e stampa solo messaggi di errore.
1, oppure w stampa avvisi ed errori.
2, o i, o a stampa tutti i messaggi.

-x Se impostato, ad sfogliare non sovrascrive mai i file HTML esistenti. (Può essere utile in
congiunzione con il -a opzione.)

-X Nome=APPREZZIAMO
Definire una variabile d'ambiente Nome con valore APPREZZIAMOIl valore sostituisce qualsiasi
definizione eventualmente già esistente di Nome nell'ambiente del sistema per questo
chiama a ad sfogliareLa nuova definizione riguarda tutti i file di configurazione elaborati
successivamente e anche il file di progetto (se presente). Il Nome non deve contenere bianco
spazio; se APPREZZIAMO contiene spazi vuoti, cita l'intera definizione come in -X"user=John
Doe". Potrebbe esserci o meno uno spazio bianco tra i -X e la variabile
definizione.

-I elenco
Definisci percorsi sorgente per ASIS. Stessa semantica di GNAT. Multiplo -I le opzioni possono
essere dato.

-T elenco
Definisci i percorsi per ASIS per cercare i file ad albero (*.adt). Multiplo -T le opzioni possono essere
dato.

Nota che se dai un nome al file -i opzione che inizia con la lettera "s",
devi avere uno spazio vuoto tra l'opzione e il nome del file, altrimenti verrà
essere riconosciuto come un -è opzione. Inoltre, se il nome del file inizia con "-", non deve
essere uno spazio vuoto tra l'opzione e il nome del file, perché se c'è, ad sfogliare
assumerà che il nome del file sia l'opzione successiva e lo gestirà come tale (tutte le opzioni
iniziare con "-") e non come nome di file.

La stessa avvertenza vale anche per il -p opzione, se si desidera che l'indice del sottoprogramma sia
vai a un file chiamato "rivate": deve esserci uno spazio vuoto, altrimenti, il tutto verrà
essere riconosciuto come il -privato opzione. (Certo che questa è un'opzione piuttosto patologica
caso, ma lo menzioniamo qui per completezza.)

IL -f OPZIONE

. -f l'opzione ha tre formati diversi:

1. Se il nome del file è "-" o "@-", ad sfogliare legge le specifiche delle unità da elaborare
da stdin, un'unità per riga, fino a quando non viene rilevato EOF. Le righe vuote vengono saltate. (Se
se provi a farlo in modo interattivo, dovrai segnalare tu stesso EOF. Altrimenti, questo potrebbe essere
utile se l'input proviene da una pipe, come in "ls -1 *.ads | adabrowse -f- ...")

2. Se il nome del file inizia con "@", ad sfogliare non lo considera una specifica unitaria, ma come
nome di un file di testo da cui leggere i nomi delle unità, un'unità per riga. Righe vuote
nel file vengono ignorati.

3. Se nessuna delle due opzioni è applicabile, ad sfogliare utilizza il nome file specificato come specifica dell'unità.

I primi due casi sono chiamati "modalità di input file" di ad sfogliareIl file potrebbe contenere
righe vuote e commenti (iniziando con il primo "#" su una riga e estendendosi fino al
fine della riga), che vengono ignorati. Si noti che, contrariamente ai file di configurazione, le stringhe
la gestione per trovare l'inizio dei commenti non è stata eseguita e anche le continuazioni di riga non sono
consentito.

In tutti e tre i casi, una specifica di unità è un nome di file che può contenere un percorso; un possibile suffisso
viene ignorato. Nota che una specifica di unità è un nome di file; in altre parole, si fornisce test-gen, o
test-gen.ads, e non Test.GenIl motivo è semplicemente che per la maggior parte degli script di shell
lingue, è più facile lavorare con i nomi dei file che trasformarli in nomi di unità (ad esempio
sostituendo i trattini con i punti). Inoltre, se hai nomi di file compressi, non esiste una soluzione semplice
collegamento tra il nome del file e il nome dell'unità.

Se una specifica di unità contiene un percorso, il file HTML per quell'unità viene inserito in quella directory
a meno che non venga annullato da un -o opzione. Nota che se la specifica dell'unità contiene un percorso, dovrai
probabilmente bisognerà anche impostare un -T or -I opzione, a meno che non si abbia l'ASIS
informazioni disponibili direttamente (ad esempio, un file ad albero per l'unità nella directory corrente;
ma non è esattamente tipico).

In modalità di immissione file, il -o l'opzione (se data) può essere "-" (nel qual caso tutti
l'output va su stdout) oppure specifica una directory, ma non deve specificare un file.

ad sfogliare presuppone uno schema di denominazione simile a GNAT per i file sorgente e HTML. Presuppone inoltre
che ci sia un'unità di libreria per file. A partire dalla versione V1.4, ad sfogliare può gestire file compressi
nomi nel -f opzione, a condizione che riesca a trovare un file sorgente e che abbia l'estensione .Annunci.
Se è così, ad sfogliare apre e analizza il file sorgente per estrarre il nome dell'unità, invece di
derivandolo direttamente dal nome del file. Nota che i file generati hanno sempre nomi basati
sul nome dell'unità, non sul nome del file originale: vale a dire, i nomi dei file di output non saranno mai
sgranchito.

I file HTML generati hanno sempre il suffisso ".html" (non ".htm").

INDICE GENERAZIONE

La generazione dell'indice è attiva quando ad sfogliare viene detto di elaborare diverse unità e l'output
non va a stdout (quando il -O- è stata data l'opzione).

Esistono diverse opzioni per controllare la generazione dell'indice:

-i or -è Attiva la generazione di un indice unitario.
-p Attiva la generazione di un indice di sottoprogramma.
-t Attiva la generazione di un indice di tipo.

Tutte queste opzioni accettano un nome file facoltativo come parametro. Se segue un nome file,
l'indice verrà scritto su quel file (o su stdout, se il nome del file è "-"). Se
non viene specificato alcun nome file, viene scelto un nome predefinito.

Tutte queste opzioni sono in realtà mantenute solo per motivi di compatibilità con le versioni precedenti. A partire da
V4.0, gli indici sono definiti principalmente tramite voci del file di configurazione, non sul comando
riga. Per non interrompere gli script esistenti utilizzando le opzioni della riga di comando precedenti
ad sfogliare versioni, queste opzioni sono ancora disponibili.

ad sfogliare presuppone che elaborerà più unità nei seguenti casi:
· In modalità di inserimento file (-f @file_name or -F-).
· Quando si utilizza un file di progetto (-P nome_file_progetto).
· Quando il -tutti l'opzione è data.

Se non viene specificato alcun nome file o non contiene un percorso, dipende dall'impostazione di
altre opzioni in cui verrà posizionato l'indice:
· In modalità di inserimento file, se un -o è data l'opzione, deve specificare una directory. Tutto l'HTML
i file, compreso l'indice, verranno inseriti in quella directory.
· Se no -o è data l'opzione, ma la prima unità specifica contiene un percorso, l'indice è messo
nella directory designata da quel percorso.
· Se non si è in modalità di input file, ma è stata specificata l'opzione -all, il -o l'opzione potrebbe
specificare un nome di file. L'indice viene inserito nella directory designata dalla parte del percorso
del nome del file (la directory corrente, se il nome del file non contiene un percorso).
· Se si utilizza un file di progetto, gli indici vengono scritti nella directory ADABROWSE_OUTPUT.
· In caso contrario, questo indice viene inserito nella directory corrente.

Se viene fornito un nome di file contenente un percorso, l'indice verrà inserito in quel file nel
directory specificata. Se il nome del file contiene solo un percorso, ad sfogliare userà quel percorso e
creare un indice denominato "index.html" nella directory designata.

Se un -x è data l'opzione (impedendo la sovrascrittura dei file HTML esistenti) ed esiste un file
già nel luogo dove ad sfogliare vuole mettere l'indice, non verrà generato alcun indice
e ad sfogliare emetterà un avviso. Avvertirà anche se non è possibile generare un indice per qualsiasi
altri motivi, ma per il resto l'elaborazione continuerà.

Utilizzare adabrowse online utilizzando i servizi onworks.net