ocamldoc - Online in de cloud

PROGRAMMA:

NAAM

ocamldoc - De OCaml-documentatiegenerator

KORTE INHOUD

ocamldoc [ opties ] bestandsnaam ...

PRODUCTBESCHRIJVING

De OCaml-documentatiegenerator ocamldoc(1) genereert documentatie van speciaal
opmerkingen ingebed in bronbestanden. De commentaren gebruikt door ocamldoc zijn van de vorm (** ...
*) en volg het formaat beschreven in de Ocuco's Medewerkers OCamli gebruiker handboek.

ocamldoc kan documentatie produceren in verschillende formaten: HTML, LaTeX, TeXinfo, Unix man
pagina's, en stip(1) afhankelijkheidsgrafieken. Bovendien kunnen gebruikers hun eigen aangepaste generatoren toevoegen.

In deze manpage gebruiken we het woord element om te verwijzen naar een van de volgende delen van een
OCaml-bronbestand: een typedeclaratie, een waarde, een module, een uitzondering, een moduletype, een
type constructor, een recordveld, een klasse, een klassetype, een klassemethode, een klassewaarde of
een klasse-overervingsclausule.

OPTIES

De volgende opdrachtregelopties bepalen de indeling voor de gegenereerde documentatie
gegenereerd door ocamldoc(1).

Opties voor betere het kiezen van the uitvoer formaat
-html Genereer documentatie in standaard HTML-indeling. De gegenereerde HTML-pagina's worden opgeslagen
in de huidige map, of in de map die is opgegeven met de -d optie. Jij kan
pas de stijl van de gegenereerde pagina's aan door het gegenereerde style.css bestand
of door uw eigen stijlblad op te geven met behulp van optie -css-stijl. Het bestand style.css
wordt niet gegenereerd als het al bestaat.

-latex Genereer documentatie in LaTeX-standaardformaat. Het gegenereerde LaTeX-document is
opgeslagen in bestand ocamldoc.uit, of in het bestand dat is opgegeven met de -o optie. De
document gebruikt het stijlbestand ocamldoc.sty. Dit bestand wordt gegenereerd bij het gebruik van de
-latex optie, als deze nog niet bestaat. U kunt dit bestand wijzigen om aan te passen
de stijl van uw LaTeX-documentatie.

-tex Genereer documentatie in TeXinfo standaardformaat. Het gegenereerde LaTeX-document is
opgeslagen in bestand ocamldoc.uit, of in het bestand dat is opgegeven met de -o optie.

-Mens Genereer documentatie als een set Unix-manpagina's. De gegenereerde pagina's worden opgeslagen
in de huidige map, of in de map die is opgegeven met de -d optie.

-punt Genereer een afhankelijkheidsgrafiek voor de modules op het hoogste niveau, in een formaat dat geschikt is voor
weergeven en verwerken door stip(1). De stip(1) gereedschap is verkrijgbaar bij
http://www.research.att.com/sw/tools/graphviz/. De tekstuele weergave van de
grafiek wordt naar het bestand geschreven ocamldoc.uit, of naar het bestand dat is opgegeven met de -o
keuze. Gebruik stip ocamldoc.uit om het weer te geven.

-g filet
Laad dynamisch het gegeven bestand (welke extensie meestal .cmo of .cma is), welke
definieert een generator voor aangepaste documentatie. Als het gegeven bestand eenvoudig is en
bestaat dan niet in de huidige directory ocamldoc zoekt het in de gewoonte
generators standaardmap, en in de mappen die zijn opgegeven met de -i optie.

-aangepaste map
Geef de standaardmap van de aangepaste generator weer.

-i directory
Voeg de opgegeven map toe aan het pad waar naar aangepaste generatoren moet worden gezocht.

Snel naar opties
-d dir Genereer bestanden in de map dir, in plaats van de huidige directory.

-dumpen filet
Dump verzamelde informatie in filet. Deze informatie is af te lezen met de -laden
optie bij een volgend beroep op ocamldoc(1).

-verbergen modules
Verberg de gegeven volledige modulenamen in de gegenereerde documentatie. modules is een
lijst met volledige modulenamen worden gescheiden door komma's (,), zonder spaties. Voor
voorbeeld: Doordringend,M2.M3.

-inv-samenvoegen-ml-mli
Keer de prioriteit van implementaties en interfaces om bij het samenvoegen. Alle
elementen in uitvoeringsdossiers worden bewaard, en de -m optie geeft aan welke onderdelen
van de commentaren in interfacebestanden worden samengevoegd met de commentaren in de implementatie
bestanden.

-behoud-code
Bewaar altijd de broncode voor waarden, methoden en instantievariabelen, wanneer
beschikbaar. De broncode wordt altijd behouden wanneer een .ml-bestand wordt gegeven, maar is door
standaard weggegooid wanneer een .mli wordt gegeven. Met deze optie kan de broncode worden
altijd gehouden.

-laden filet
Laad informatie van filet, die is geproduceerd door ocamldoc -dumpen. verscheidene
-laden opties kunnen worden gegeven.

-m vlaggen
Specificeer samenvoegopties tussen interfaces en implementaties. vlaggen kan een of
meerdere van de volgende karakters:

d beschrijving samenvoegen

a voeg @auteur samen

v voeg @versie samen

l samenvoegen @zien

s samenvoegen @sinds

o @verouderd samenvoegen

p voeg @param

e voeg @raise samen

r samenvoegen @terug

A alles samenvoegen

-geen-aangepaste-tags
Sta geen aangepaste @-tags toe.

-geen stop
Houd elementen achter de (**/**) speciale opmerking.

-o filet
Voer de gegenereerde documentatie uit naar filet in plaats van ocamldoc.uit. Deze optie is
alleen zinvol in combinatie met de -latex, -texof -punt opties.

-pp commando
Buig bronnen door preprocessor commando.

-ppx commando
Pipe abstracte syntaxisboom door preprocessor commando.

-soort Sorteer de lijst met modules op het hoogste niveau voordat u de documentatie genereert.

-sterren Verwijder lege tekens tot het eerste sterretje ('*') in elke commentaarregel.

-t titel
Gebruiken titel als titel voor de gegenereerde documentatie.

-inleiding filet
Gebruik inhoud van filet as ocamldoc tekst om als inleiding te gebruiken (HTML, LaTeX en
alleen TeXinfo). Voor HTML wordt het bestand gebruikt om het hele "index.html"-bestand te maken.

-v Uitgebreide modus. Geef voortgangsinformatie weer.

-versie
Print versie string en sluit af.

-v num Druk het korte versienummer af en sluit af.

-waarschuwingsfout
Traktatie ocamldoc waarschuwingen als fouten.

-hide-waarschuwingen
Niet afdrukken ocamldoc waarschuwingen.

-Help or --help
Geef een kort gebruiksoverzicht weer en sluit af.

Typecontrole opties
ocamldoc(1) roept de OCaml-typecontrole op om type-informatie te verkrijgen. De volgende opties
gevolgen hebben voor de typecontrolefase. Ze hebben dezelfde betekenis als voor de
ocamlc(1) en ocamlopt(1) commando's.

-I directory
Toevoegen directory naar de lijst met mappen zoeken naar gecompileerde interfacebestanden (.cmi
bestanden).

-geenlabels
Negeer niet-optionele labels in typen.

-rectypen
Sta willekeurige recursieve typen toe. (Zie de -rectypen optie om ocamlc(1).)

Opties voor betere het genereren van HTML paginas
De volgende opties zijn van toepassing in combinatie met de -html optie:

-alle parameters
Geef de volledige lijst met parameters voor functies en methoden weer.

-css-stijl bestandsnaam
Gebruiken bestandsnaam als het Cascading Style Sheet-bestand.

-kleurcode
Kleur de OCaml-code tussen [ ] en \{[ ]\} in en gebruik kleuren om te benadrukken
trefwoorden, enz. Als de codefragmenten niet syntactisch correct zijn, is geen kleur dat
toegevoegd.

-index-alleen
Genereer alleen indexbestanden.

-korte functoren
Gebruik een kort formulier om functors weer te geven: module M : functie (A:Module) -> functie
(B: Module2) -> sig .. einde wordt weergegeven als module M (A:Module) (B: Module2) : sig ..
einde.

Opties voor betere het genereren van Latex bestanden
De volgende opties zijn van toepassing in combinatie met de -latex optie:

-latex-waarde-voorvoegsel voorvoegsel
Geef een voorvoegsel op om te gebruiken voor de labels van de waarden in het gegenereerde LaTeX-document.
Het standaardvoorvoegsel is de lege tekenreeks. U kunt ook de opties gebruiken -latex-type-
voorvoegsel, -latex-uitzonderingsvoorvoegsel, -latex-module-voorvoegsel, -latex-module-type-voorvoegsel,
-latex-klasse-voorvoegsel, -latex-klasse-type-voorvoegsel, -latex-attribuut-voorvoegselen -latex-
methode-voorvoegsel.

Deze opties zijn handig als u bijvoorbeeld een type en een waarde hebt bij de
zelfde naam. Als u geen voorvoegsels opgeeft, zal LaTeX klagen over vermenigvuldigen
gedefinieerde etiketten.

-latextitel n, stijl
Associeer stijlnummer n naar het gegeven LaTeX-sectiecommando stijl, bijv
sectieoronderafdeling. (Alleen LaTeX.) Dit is handig wanneer u het gegenereerde
document in een ander LaTeX-document, op een bepaald sectieniveau. De standaard
associatie is 1 voor sectie, 2 voor subsectie, 3 voor subsubsectie, 4 voor
lid en 5 voor alinea.

- geen kop
Koptekst in gegenereerde documentatie onderdrukken.

-notoc Maak geen inhoudsopgave.

-geen aanhangwagen
Onderdruk trailer in gegenereerde documentatie.

-sepbestanden
Genereer één .tex-bestand per module op het hoogste niveau, in plaats van het globale ocamldoc.uit
bestand.

Opties voor betere het genereren van TeXinfo bestanden
De volgende opties zijn van toepassing in combinatie met de -tex optie:

-esc8 Escape-tekens met accenten in Info-bestanden.

-info-invoer
Geef Info-directory-item op.

-info-sectie
Geef sectie van Info-directory op.

- geen kop
Koptekst in gegenereerde documentatie onderdrukken.

-geenindex
Bouw geen index voor Info-bestanden.

-geen aanhangwagen
Onderdruk trailer in gegenereerde documentatie.

Opties voor betere het genereren van stip grafieken
De volgende opties zijn van toepassing in combinatie met de -punt optie:

-punt-kleuren kleuren
Geef de kleuren op die moeten worden gebruikt in de gegenereerde puntcode. Bij het genereren van module
afhankelijkheden, ocamldoc(1) gebruikt verschillende kleuren voor modules, afhankelijk van de
mappen waarin ze zich bevinden. Bij het genereren van afhankelijkheden van typen, ocamldoc(1)
gebruikt verschillende kleuren voor types, afhankelijk van de modules waarin ze zitten
gedefinieerd. kleuren is een lijst met kleurnamen gescheiden door komma's (,), zoals in
Rood, Blauw, Groen. De beschikbare kleuren zijn de kleuren die worden ondersteund door de stip(1) gereedschap.

-dot-inclusief-alles
Neem alle modules op in de stip(1) uitvoer, niet alleen modules die op het commando worden gegeven
lijn of geladen met de -laden optie.

-punt-verkleinen
Voer een transitieve reductie van de afhankelijkheidsgrafiek uit voordat u de punt uitvoert
code. Dit kan handig zijn als er veel transitieve afhankelijkheden zijn die onoverzichtelijk zijn
de grafiek.

-punt-types
Uitvoerpuntcode die de typeafhankelijkheidsgrafiek beschrijft in plaats van de module
afhankelijkheid grafiek.

Opties voor betere het genereren van man bestanden
De volgende opties zijn van toepassing in combinatie met de -Mens optie:

-man-mini
Genereer in plaats daarvan alleen man-pagina's voor modules, moduletypen, klassen en klassetypen
van pagina's voor alle elementen.

-man-achtervoegsel achtervoegsel
Stel het achtervoegsel in dat wordt gebruikt voor gegenereerde man-bestandsnamen. Standaard is o, zoals in Lijst.o.

-man-sectie sectie
Stel het sectienummer in dat wordt gebruikt voor gegenereerde man-bestandsnamen. Standaard is 3.

Gebruik ocamldoc online met behulp van onworks.net-services