Das Skript buildwebdocs.fan generiert die Dokumentation für die Pods der Distribution, aber nicht für die Pods, die ich selbst erstellt oder importiert habe. Wie kann ich die Dokumentation lokal für diese Pods generieren?So generieren Sie lokal die Dokumentation für einen importierten Pod
können Sie rufen compilerDoc selbst:
$ fan compilerDoc -?
Usage:
compilerDoc [options] <pods>*
Arguments:
pods Name of pods to compile (does not update index)
Options:
-help, -? Print usage help
-all Generate docs for every installed pods
-allCore Generation docs for Fantom core pods
-clean Delete outDir
-outDir <File> Output dir for doc files
Also für Sie lokalen pod:
$ fan compilerDoc myPod
Das ist eine schwierige Frage, und ich habe keine unmittelbare Antwort (oder Skript) für. Jedoch vorausgesetzt, Sie nur zu Ansicht wünschen die Dokumentation und kein Verzeichnis von HTML-Dateien benötigen, dann kann ich eine Alternative ...
installieren und verwenden Sie die Explorer Anwendung. Es ist eine Desktop-Datei-Explorer-Anwendung, die unter anderem eine Fandoc Viewer enthält, mit der Sie Dokumentation von Pods in der aktuellen Fantom-Installation anzeigen können.
Beispiel in der Dokumentation für die afReflux pod anzuzeigen, geben Sie afReflux (Groß- und Kleinschreibung) in der Adressleiste:
Sie auch F1 eine Indexseite aufzurufen drücken alle installierten Fantom Pods.