Dies ist der Befehl dh_ocamldoc, der beim kostenlosen Hosting-Anbieter OnWorks mit einer unserer zahlreichen kostenlosen Online-Workstations wie Ubuntu Online, Fedora Online, dem Windows-Online-Emulator oder dem MAC OS-Online-Emulator ausgeführt werden kann
PROGRAMM:
NAME/FUNKTION
dh_ocamldoc – Erstellt Dokumentation für OCaml-Bibliotheken
ZUSAMMENFASSUNG
dh_ocamldoc [debhelper Optionen]
BESCHREIBUNG
dh_ocamldoc sucht nach allen Dateien, die mit „debian/$package.ocamldoc*“ übereinstimmen, wo es sie finden kann
Flags, die an ocamldoc übergeben werden, das mit allen .mli-Dateien (oder .ml) aufgerufen wird
wenn keine passende .mli-Datei in debian/package/usr/lib/ocaml gefunden wird. Jedes „.ocamldoc*“
Die Datei wird zum Generieren einer anderen Dokumentation verwendet, wobei der Teil nach „ocamldoc“ kommt.
im Dateinamen wird als Dokument-ID in der Doc-Basisdatei verwendet.
Sie können mehrere Flags pro Zeile haben. Zeilen, die mit „--include“ beginnen, haben eine Besonderheit
Bedeutung: Was auch immer auf „--include“ folgt, wird als Liste der Verzeichnisse betrachtet, in denen
Für die Dokumentationserstellung werden .mli- oder .ml-Dateien durchsucht. Die Verzeichnisse werden
kann auch zum Suchpfad der Ocamldoc-Bibliothek hinzugefügt werden. Dies kann für die Generierung nützlich sein
Dokumentation in einem eigenen Binärpaket. Beachten Sie, dass Sie dies zu diesem Zweck sicherstellen sollten
Das Paket, das die Dokumentation versendet, wird von dh_ocamldoc nach dem Paket behandelt
Versand der eigentlichen Objekte.
Das Flag „-d“ wird erkannt und zum Generieren der entsprechenden Doc-Base-Datei verwendet. Es beinhaltet
der Pfad des Dokumentationsverzeichnisses und ist relativ zu „/ usr / share / doc /$package/". Die
Der Standardwert ist „html/api“.
dh_ocamldoc erkennt automatisch, ob stattdessen „ocamlfind ocamldoc“ aufgerufen werden sollte
einfach „ocamldoc“ (dies geschieht durch die Suche nach gängigen ocamlfind-Optionen wie: -package,
-Prädikate usw.).
Zeilen, die in *ocamldoc-Dateien mit „#“ beginnen, sind Kommentare und werden daher ignoriert.
Wenn Sie die im Tarball des Upstreams vorhandene Dokumentation (falls vorhanden) installieren möchten, können Sie dies tun
Fügen Sie „--doc-base-generate“ in Ihre .ocamldoc-Datei ein, um dh_ocamldoc anzuweisen, das zu generieren
Nur .doc-base-Datei.
OPTIONAL
-X Dateien
Schließen Sie Dateien von der Dokumentationsverarbeitung aus.
-u Fahnen
Zusätzliche Flags zu „ocamldoc“ oder „ocamlfind ocamldoc“.
Verwenden Sie dh_ocamldoc online über die Dienste von onworks.net
