fpdoc-3.0.0 – Online in der Cloud

PROGRAMM:

NAME/FUNKTION

fpdoc – Der Dokumentationsgenerator für FPC Pascal-Einheiten.

ZUSAMMENFASSUNG

fpdoc --input=inputcommand [--output=output] [--format=fmt] [--descr=descriptionfile]
[--package=Paketname] [Optionen]

Beschreibung

fpdoc scannt eine Free Pascal-Unit-Quelldatei und generiert eine Dokumentation dafür. Der
Die Dokumentation kann in verschiedenen Formaten vorliegen (derzeit HTML und LaTeX). Sie kann verschiedene lesen
Beschreibungsdateien, die die Beschreibung der verschiedenen im Gerät vorkommenden Symbole enthalten
Datei.

Anwendungsbereich

Sie können aufrufen fpdoc mit den einzigen erforderlichen Argumenten „input“ und „package“
Argumente. Sie sollte mindestens den Namen der Unit-Datei enthalten, für die Dokumentation
generiert werden soll und den Namen des Pakets, zu dem die Einheit gehört.

Optionen

fpdoc verfügt über mehrere Optionen, von denen die meisten optional sind. In den meisten Fällen werden Standardeinstellungen verwendet.

--Inhalt
Diese Option sagt fpdoc um eine Inhaltsdatei zu generieren. Eine Inhaltsdatei enthält eine Liste
aller möglichen Anker (Labels) in der generierten Dokumentationsdatei und kann
können verwendet werden, um Querverweise in der Dokumentation verschiedener Einheiten herzustellen
--importieren .

--cputarget=Wert
Diese Option sagt fpdoc für welche CPU die Dokumentation erstellt werden soll. Das einfach
definiert die entsprechenden CPU-Makros.

--descr=descfile
Diese Option gibt den Namen einer Beschreibungsdatei an Beschreibung das enthält die
aktuelle Dokumentation für das Gerät. Diese Option kann mehrfach gegeben werden, z
mehrere Beschreibungsdateien.

--descr-dir=dir
Diese Option gibt den Namen eines Verzeichnisses mit XML-Beschreibungsdateien namens an dir
Diese Option kann für mehrere Beschreibungsverzeichnisse mehrmals angegeben werden. Das
Die Option entspricht der Angabe aller Dateien im Verzeichnis mit --descr
.

--nicht-trimmen
Diese Option weist fpdoc an, Leerzeichen in den XML-Dateien nicht zu entfernen. Standardmäßig,
Leerzeichen werden aus der Eingabe entfernt, was unerwünschte Nebenwirkungen haben kann
zum Beispiel PRE-Tags.

--Probelauf
Diese Option sagt fpdoc keine Ausgabe generieren, sondern nur alle Eingaben analysieren. Das
kann mit der verbose-Option verwendet werden, um zu überprüfen, welche Fehler in der Datei verbleiben
Dokumentation oder was noch fehlt.

--format=fmt
Gibt das Format an fmt in dem die Dokumentation erstellt wird. Derzeit,
Folgende Formate sind bekannt:

chm CHM mit 8.3-konformen Dateinamen, hauptsächlich für Windows.

dxml Delphi-kompatible XML-Ausgabe.

htm HTML mit 8.3-konformen Dateinamen.

html HTML mit langen Dateinamen.

ipf IPF-Ausgabe (OS/2-Format, kann mit docview von fpGUI verwendet werden).

xhtml XHTML mit langen Dateinamen.

Latex LaTex, das den in der Free Pascal-Dokumentation verwendeten fpc.sty-Stil verwendet.

Mann Manpage-Ausgabe (Unix-Handbuchseiten, eine Seite pro Kennung).

rtf RTF-Ausgabe.

txt Klartextausgabe.

xml-Struktur
Strukturiertes XML.

--help Zeigt eine Zusammenfassung der Befehlszeilenoptionen an.

--hide-protected
Standardmäßig enthält die Dokumentation Beschreibungen und Auflistungen der geschützten
Felder und Methoden in Klassen oder Objekten. Diese Option ändert dieses Verhalten; wenn es
angegeben ist, wird für diese Methoden keine Dokumentation generiert. Beachten Sie, dass
Öffentliche Methoden oder Eigenschaften, die auf diese geschützte Methode verweisen, haben dann eine
baumelnder (dh nicht verfügbarer) Link.

--html-search=Link
Fügt einen Eintrag für eine HTML-Suchseite am Standort hinzu Link in den Kopfzeilen der
generierte HTML-Seiten. Es ist keine Suchseite vorhanden, dies sollte gemacht werden und
vom Benutzer bereitgestellt.

--import=impfile
importiert eine Inhaltsdatei impfdatei aus einem anderen Dokumentationssatz. Dies kann dazu genutzt werden
Verweise auf Elemente in dieser anderen Dokumentationsdatei auflösen;

--input=cmd
Diese Option sagt fpdoc welche Eingabedatei verwendet werden soll. Das Argument cmd kann sein
nur ein Dateiname, kann aber auch eine vollständige Compiler-Befehlszeile mit Optionen sein
betreffen das Scannen der Pascal-Quelle: definiert, Dateien einschließen, Syntaxoptionen,
wie sie dem Free Pascal-Compiler beim Kompilieren der Datei angegeben würden. Wenn
Wird ein vollständiger Befehl verwendet, sollte dieser in einfache oder doppelte Anführungszeichen gesetzt werden.
damit die Schale sie nicht in Teile zerbricht. Es ist möglich, mehrere anzugeben
Eingabebefehle; Sie werden einzeln behandelt und dokumentiert
für jeden von ihnen generiert.

--input-dir=dir
Diese Option sagt fpdoc um alle .pas- und .pp-Dateien im genannten Verzeichnis hinzuzufügen cmd as
Eingabedateien an den Dokumentierer. Dies entspricht der Angabe aller Dateien im
Verzeichnis mit dem --Eingang Befehl.

--lang=Sprache
Legt die Sprache für die Ausgabedatei fest. Dadurch werden hauptsächlich die Zeichenfolgen eingestellt, die für verwendet werden
die Header in verschiedenen Teilen der Dokumentationsdateien (standardmäßig sind sie in
Englisch). Derzeit gültige Optionen sind

de Deutsch.

fr Französisch.

nl Dutch.

--latex-extension=ext
Legt die für die LaTeX-Datei zu verwendende Erweiterung fest ext Der Standardwert ist .tex (mit .
(Punkt) enthalten).

--latex-highlight
Schaltet einen internen Latex-Syntax-Highlighter ein. Dies ist noch nicht umgesetzt. Von
Standardmäßig wird die Syntaxhervorhebung durch das Syntaxpaket bereitgestellt, das mit fpc geliefert wird.

--mo-dir=dir
Diese Option sagt fpdoc wo nach den Übersetzungsdateien gesucht werden kann, die verwendet werden können
Internationalisierung der Ausgabe von fpdoc.

--ostarget=Wert
Diese Option sagt fpdoc für welches Betriebssystem die Dokumentation erstellt werden soll. Das
Definiert lediglich die entsprechenden Betriebssystemmakros.

--output=Name
Diese Option sagt fpdoc wo die Ausgabedatei generiert werden soll. Wie diese Option
Die Interpretation hängt vom verwendeten Format ab. Für Latex, Name wird interpretiert
als Dateiname für die tex-Datei. Für alle anderen Formate: Name wird interpretiert als
Verzeichnis, in das alle Dokumentationsdateien geschrieben werden. Das Verzeichnis wird sein
erstellt, falls es noch nicht existiert. Standardmäßig entspricht dies dem Paketnamen.

--package=Paketname
Gibt den Paketnamen an. Alle Einheiten werden im Rahmen von dokumentiert Paketname ,
Dies ist auch der Standardname oder das Standardverzeichnis für die Ausgabedatei. Nur Dokumentationsknoten
innerhalb eines Paketknotens mit diesem Namen werden bei der Dokumentation berücksichtigt.

--parse-impl
(Experimentell) Versuchen Sie auch, die Implementierung einer Einheit zu analysieren. Dies kann verwendet werden
Syntaxprüfung.

--project=Datei
Diese Option sagt fpdoc um alle Optionen aus einer Projektdatei zu lesen. Dies ist ein XML
Weitere Informationen zum Format dieser Datei finden Sie in der Dokumentation
Datei.

--show-private
Standardmäßig wird keine Dokumentation für private Methoden oder Felder generiert. Das
Option verursacht fpdoc um auch für diese Methoden eine Dokumentation zu erstellen.

- ausführlich
Standardmäßig fpdoc ist spärlich mit der Ausgabe. Dies weist fpdoc an, noch mehr zu generieren
Informationen darüber, was es tut.

--warn-no-node
Wenn diese Option angegeben ist, fpdoc gibt eine Warnung aus, wenn keine gefunden wird
Beschreibungsknoten für einen Bezeichner, den er dokumentiert.

--write-project=Datei
Wenn diese Option angegeben ist, fpdoc schreibt eine fpdoc-Projektdatei (in die
angegebener Dateiname), der den angegebenen Befehlszeilenoptionen entspricht.

Verwenden Sie fpdoc-3.0.0 online über die Dienste von onworks.net