ocamldoc - Online nel cloud

PROGRAMMA:

NOME

ocamldoc - Il generatore di documentazione OCaml

SINOSSI

ocamldoc [ Opzioni ] Nome del file ...

DESCRIZIONE

Il generatore di documentazione OCaml ocamldoc(1) genera documentazione da speciali
commenti incorporati nei file sorgente. I commenti usati da ocamldoc sono della forma (** ...
*) e seguire il formato descritto nel Le OCaml degli utenti Manuale.

ocamldoc può produrre documentazione in vari formati: HTML, LaTeX, TeXinfo, Unix man
pagine, e punto(1) grafici delle dipendenze. Inoltre, gli utenti possono aggiungere i propri generatori personalizzati.

In questa manpage usiamo la parola elemento fare riferimento a una delle seguenti parti di an
File sorgente OCaml: una dichiarazione di tipo, un valore, un modulo, un'eccezione, un tipo di modulo, a
costruttore di tipo, un campo record, una classe, un tipo di classe, un metodo di classe, un valore di classe o
una clausola di ereditarietà di classe.

VERSIONI

Le seguenti opzioni della riga di comando determinano il formato della documentazione generata
generato da ocamldoc(1).

Opzioni per la scelta , il produzione formato
-html Genera documentazione in formato HTML predefinito. Le pagine HTML generate vengono memorizzate
nella directory corrente, o nella directory specificata con -d opzione. Puoi
personalizzare lo stile delle pagine generate modificando il generato style.css file,
o fornendo il proprio foglio di stile utilizzando l'opzione -stile css. Il file style.css
non viene generato se esiste già.

-lattice Genera documentazione nel formato predefinito di LaTeX. Il documento LaTeX generato è
salvato nel file ocamldoc.out, o nel file specificato con il -o opzione. Il
documento usa il file di stile ocamldoc.sty. Questo file viene generato quando si utilizza il
-lattice opzione, se non esiste già. Puoi modificare questo file per personalizzarlo
lo stile della tua documentazione LaTeX.

-tex Genera documentazione nel formato predefinito di TeXinfo. Il documento LaTeX generato è
salvato nel file ocamldoc.out, o nel file specificato con il -o opzione.

-uomo Genera documentazione come un insieme di pagine man di Unix. Le pagine generate vengono memorizzate
nella directory corrente, o nella directory specificata con -d opzione.

-punto Genera un grafico delle dipendenze per i moduli di primo livello, in un formato adatto a
visualizzazione ed elaborazione da punto(1). Il punto(1) lo strumento è disponibile da
http://www.research.att.com/sw/tools/graphviz/. La rappresentazione testuale del
il grafico è scritto nel file ocamldoc.out, o al file specificato con il -o
opzione. Uso punto ocamldoc.out per visualizzarlo.

-g filetto
Carica dinamicamente il file dato (la cui estensione di solito è .cmo o .cma), che
definisce un generatore di documentazione personalizzato. Se il file dato è semplice e
non esiste nella directory corrente, quindi ocamldoc lo cerca nella consuetudine
directory di default dei generatori, e nelle directory specificate con -i opzione.

-dir.personale
Visualizza la directory predefinita dei generatori personalizzati.

-i elenco
Aggiungi la directory specificata al percorso in cui cercare i generatori personalizzati.

Generale Opzioni
-d dir Genera file nella directory dir, anziché la directory corrente.

dump filetto
Scarica le informazioni raccolte in filetto. Queste informazioni possono essere lette con il -caricare
opzione in una successiva invocazione di ocamldoc(1).

-nascondere moduli
Nascondi i nomi dei moduli completi forniti nella documentazione generata. moduli è un
l'elenco dei nomi dei moduli completi è separato da virgole (,), senza spazi. Per
esempio: Pervasivi, M2.M3.

-inv-merge-ml-mli
Invertire la precedenza delle implementazioni e delle interfacce durante l'unione. Tutto
gli elementi nei file di implementazione sono mantenuti e il -m l'opzione indica quali parti
dei commenti nei file di interfaccia vengono uniti ai commenti nell'implementazione
File.

-mantieni-codice
Conserva sempre il codice sorgente per valori, metodi e variabili di istanza, quando
a disposizione. Il codice sorgente viene sempre mantenuto quando viene fornito un file .ml, ma è da
default scartato quando viene fornito un .mli. Questa opzione consente al codice sorgente di essere
sempre tenuto.

-caricare filetto
Carica informazioni da filetto, che è stato prodotto da ocamldoc dump. Parecchi
-caricare si possono dare opzioni.

-m bandiere
Specificare le opzioni di unione tra interfacce e implementazioni. bandiere può essere uno o
alcuni dei seguenti caratteri:

d unisci descrizione

a unisci @autore

v unisci @versione

l unisci @see

s unisci @since

o unisci @deprecato

p unisci @param

e unisci @raise

r unisci @return

A unisci tutto

-no-tag-personalizzati
Non consentire tag @ personalizzati.

-senza interruzioni
Mantieni gli elementi posizionati dopo il (**/**) commento speciale.

-o filetto
Invia la documentazione generata a filetto invece di ocamldoc.out. Questa opzione è
significativo solo in combinazione con il -lattice, -tex, o -punto opzioni.

-pp command
Convogliare le fonti attraverso il preprocessore command.

-ppx command
Convogliare l'albero della sintassi astratta attraverso il preprocessore command.

-ordinare Ordina l'elenco dei moduli di primo livello prima di generare la documentazione.

-stelle Rimuovi i caratteri vuoti fino al primo asterisco ('*') in ogni riga di commenti.

-t titolo
Usa il titolo come titolo per la documentazione generata.

-introduzione filetto
Usa il contenuto di filetto as ocamldoc testo da usare come introduzione (HTML, LaTeX e
solo TeXinfo). Per HTML, il file viene utilizzato per creare l'intero file "index.html".

-v Modalità dettagliata. Visualizza le informazioni sullo stato di avanzamento.

-versione
Stampa la stringa della versione ed esci.

-vnum Stampa il numero di versione breve ed esci.

-Avviso-errore
TRATTARE ocamldoc avvisi come errori.

-nascondi-avvertimenti
Non stampare ocamldoc avvertenze.

-Aiuto or --Aiuto
Visualizza un breve riepilogo dell'utilizzo ed esci.

Controllo del tipo Opzioni
ocamldoc(1) chiama il type-checker OCaml per ottenere informazioni sul tipo. Le seguenti opzioni
influenzare la fase di verifica del tipo. Hanno lo stesso significato di
ocamlc(1) e ocamlopt(1) comandi.

-I elenco
Aggiungi elenco nell'elenco delle directory cercare i file di interfaccia compilati (.cmi
File).

-nolabel
Ignora le etichette non facoltative nei tipi.

-rectipi
Consenti tipi ricorsivi arbitrari. (Vedi il -rectipi opzione a ocamlc(1).)

Opzioni per la generazione di HTML pagine
Le seguenti opzioni si applicano in combinazione con il -html opzione:

-tutti i parametri
Visualizza l'elenco completo dei parametri per funzioni e metodi.

-stile css Nome del file
Usa il Nome del file come file del foglio di stile a cascata.

-colorize-codice
Colora il codice OCaml racchiuso tra [ ] e \{[ ]\}, usando i colori per enfatizzare
parole chiave, ecc. Se i frammenti di codice non sono sintatticamente corretti, nessun colore è
aggiunto.

-solo indice
Genera solo file di indice.

-funtori-corti
Utilizzare una forma breve per visualizzare i funtori: modulo M : funtore (A: Modulo) -> funtore
(B: Modulo2) -> sig .. fine viene visualizzato come modulo M (A: Modulo) (B: Modulo2) : sig ..
fine.

Opzioni per la generazione di LaTeX file
Le seguenti opzioni si applicano in combinazione con il -lattice opzione:

-prefisso-valore-lattice prefisso
Dare un prefisso da usare per le etichette dei valori nel documento LaTeX generato.
Il prefisso predefinito è la stringa vuota. Puoi anche usare le opzioni -tipo-lattice-
prefisso, -prefisso-eccezione-lattice, -prefisso-modulo-lattice, -prefisso-tipo-modulo-lattice,
-prefisso-classe-lattice, -prefisso-tipo-classe-lattice, -prefisso-attributo-lattice e -lattice-
prefisso del metodo.

Queste opzioni sono utili quando hai, ad esempio, un tipo e un valore con il
stesso nome. Se non specifichi i prefissi, LaTeX si lamenterà di moltiplicare
etichette definite.

-latextitolo n, stile
Numero stile associato n al comando di sezionamento LaTeX dato style, per esempio
paginaorsottosezione. (Solo LaTeX.) Questo è utile quando si include il generato
documento in un altro documento LaTeX, a un dato livello di sezionamento. Il predefinito
associazione è 1 per la sezione, 2 per la sottosezione, 3 per la sottosezione, 4 per
paragrafo e 5 per il comma.

-nessuna intestazione
Elimina l'intestazione nella documentazione generata.

-noc Non generare un sommario.

-non rimorchio
Elimina trailer nella documentazione generata.

-sepfile
Genera un file .tex per modulo di livello superiore, invece del file globale ocamldoc.out
file.

Opzioni per la generazione di TeXinfo file
Le seguenti opzioni si applicano in combinazione con il -tex opzione:

-esc8 Escape caratteri accentati nei file Info.

-info-immissione
Specificare la voce della directory delle informazioni.

-sezione-info
Specificare la sezione della directory Info.

-nessuna intestazione
Elimina l'intestazione nella documentazione generata.

-noindice
Non creare indici per i file di informazioni.

-non rimorchio
Elimina trailer nella documentazione generata.

Opzioni per la generazione di punto grafici
Le seguenti opzioni si applicano in combinazione con il -punto opzione:

-punti-colori Colori
Specificare i colori da utilizzare nel codice punto generato. Quando si genera il modulo
dipendenze, ocamldoc(1) utilizza colori diversi per i moduli, a seconda del
directory in cui risiedono. Quando si generano le dipendenze dei tipi, ocamldoc(1)
utilizza colori diversi per le tipologie, a seconda dei moduli in cui si trovano
definito. Colori è un elenco di nomi di colori separati da virgole (,), come in
Rosso, blu, verde. I colori disponibili sono quelli supportati dal punto(1) strumento.

-punto-include-tutto
Includere tutti i moduli nel punto(1) output, non solo moduli dati su comando
linea o caricato con il -caricare opzione.

-punto-riduci
Eseguire una riduzione transitiva del grafico delle dipendenze prima di emettere il punto
codice. Questo può essere utile se ci sono molte dipendenze transitive che ingombrano
il grafo.

-tipi-punto
Codice punto di output che descrive il grafico delle dipendenze del tipo invece del modulo
grafico delle dipendenze.

Opzioni per la generazione di uomo file
Le seguenti opzioni si applicano in combinazione con il -uomo opzione:

-uomo-mini
Genera invece pagine man solo per moduli, tipi di modulo, classi e tipi di classe
di pagine per tutti gli elementi.

-man-suffisso suffisso
Imposta il suffisso utilizzato per i nomi dei file man generati. Il valore predefinito è o, come in Elenco.o.

-sezione-uomo pagina
Imposta il numero di sezione utilizzato per i nomi dei file man generati. Il valore predefinito è 3.

Usa ocamldoc online utilizzando i servizi onworks.net