autogsdoc - Online in der Cloud

PROGRAMM:

NAME/FUNKTION

autogsdoc - GNUstep API-Dokumentationsgenerator und XML->HTML-Konverter

ZUSAMMENFASSUNG

autogsdoc [-Dateien Dateinamen] [-Erzeuge HTML JA|Nein] [-Sauber ja|NEIN] [-Saubere Vorlagen
ja|NEIN] [-Abhängigkeiten ignorieren ja|NEIN] [-Abhängigkeiten erstellen ja|NEIN] [-Abhängigkeiten anzeigen ja|NEIN]
[-HeaderDirectory Weg] [-Dokumentationsverzeichnis Weg] [-Erklärt Standort] [-Projekt
Titel] [-Normen ja|NEIN] [-DocumentAllInstanceVariables ja|NEIN]
[-DocumentInstanceVariablen JA|Nein] [-InstanceVariablesAtEnd ja|NEIN] [-KonstantenVorlage
Dateinamen] [-Funktionsvorlage Dateinamen] [-Makros-Vorlage Dateinamen] [-TypedefsTemplate
Dateinamen] [-Variablen-Vorlage Dateinamen] [-SystemProjekte Schnur] [-LokaleProjekte Schnur]
[-Projekte dictString] [-Ausführlich ja|NEIN] [-Warnen ja|NEIN] [-Weltkarte dictString] [Dateien]

BESCHREIBUNG

Das autogsdoc-Tool ist ein Befehlszeilen-Dienstprogramm, das Entwicklern hilft, Referenzen zu erstellen
Dokumentation für GNUstep-APIs. Es ermöglicht Entwicklern auch, andere zu schreiben und zu pflegen
Dokumentation in XML und lassen Sie diese in HTML konvertieren. Im Detail wird autogsdoc:

- Extrahieren Sie spezielle Kommentare, die die öffentlichen Schnittstellen von Klassen, Kategorien,
Protokolle, Funktionen und Makros aus dem Objective-C-Quellcode (Header-Dateien und
optional Quelldateien) in GSDoc XML-Dateien.

- Konvertieren Sie GSDoc XML-Dateien, egal ob aus Quellcode generiert oder manuell geschrieben von
Entwickler, in HTML.

- Erstellen Sie Indizes basierend auf GSDoc XML-Dateisätzen und konvertieren Sie diese ebenfalls in HTML.

Die häufigste Verwendung ist die Ausführung des Befehls mit einem oder mehreren Header-Dateinamen als
Argumente ... das Tool parst automatisch die entsprechenden Quelldateien im selben
Verzeichnis als Kopfzeilen (oder das aktuelle Verzeichnis oder das mit dem
DocumentationDirectory-Standard) und erzeugen GSDoc- und HTML-Dateien als Ausgabe. Für das Beste
Ergebnisse dieser Modus sollte von dem Verzeichnis aus ausgeführt werden, das die Quelldateien enthält. (Notiz
dass, da C eine Untermenge von Objective C ist, dieses Werkzeug funktionieren kann, um Funktionen zu dokumentieren und
andere C-Strukturen in reiner C-Quelle.)

GSDoc-Dateien können auch direkt zusätzlich oder allein angegeben werden und werden konvertiert
zu HTML. Siehe die GSDoc HTML-Dokumentation oder die gsdoc(7) man-Seite für Informationen über die
GSDoc-Format.

Schließlich können HTML-Dateien auf der Befehlszeile angegeben werden. Querverweise auf andere Teile von
Die darin enthaltene Codedokumentation wird basierend auf dem, was in der Datei gefunden wird, neu geschrieben
Projekt derzeit.

SOURCE CODE AUSZEICHNUNG

Der Quellcode-Parser erstellt automatisch GSDoc-Dokumente, in denen die Methoden in
die in den Quelldateien gefundenen Klassen und enthält Text aus speziell formatierten
Kommentare aus den Quelldateien.

Jeder Kommentar, der mit Schrägstrich und beginnt XNUMX Sternchen statt der üblichen Schrägstriche und Singles
Sternchen, wird als GSDoc-Markup angesehen, um als Beschreibung der Klasse oder Methode verwendet zu werden
folgt ihm. Dieser Kommentartext wird neu formatiert und dann in die Ausgabe eingefügt.
Wenn mehrere Kommentare mit demselben Element verknüpft sind, werden sie mit a . verbunden
Zeilenumbruch ( ) zwischen jedem, falls erforderlich.

Mit dem Tool lassen sich sowohl Programme als auch Bibliotheken problemlos dokumentieren, indem Sie es einfach angeben
der Name der Quelldatei, die die main()-Funktion des Programms enthält - es dauert die
spezielle Kommentare von dieser Funktion und behandelt sie speziell und fügt sie als a . ein
Abschnitt am Ende des ersten Kapitels des Dokuments (erzeugt das erste Kapitel, wenn
notwendig).

Optionen sind im Abschnitt beschrieben Argumente und Defaults unten mit.

EXTRA AUSZEICHNUNG

Es gibt einige Fälle, in denen besondere Sonderbearbeitungen durchgeführt werden, vor allem in den
erster in der Quelldatei gefundener Kommentar, aus dem verschiedene Teile des GSDoc-Markups stammen können
extrahiert und an den entsprechenden Stellen im Ausgabedokument platziert -

AutogsdocQuelle:
In jeder Zeile, wo AutogsdocQuelle: gefunden wird, wird der Rest der Zeile als a
zu verwendender Quelldateiname, anstatt davon auszugehen, dass jede .h-Datei
verarbeitet verwendet eine .m-Datei mit demselben Namen. Sie können mehrere angeben AutogsdocQuelle:
Zeilen, in denen eine Headerdatei Elemente deklariert, die in mehreren Quelldateien definiert sind.
Wenn ein Dateiname absolut ist, wird er wie angegeben verwendet. Ist es andererseits a
relativer Pfad, die Software sucht die Quelldatei zuerst relativ zum Speicherort
der Header-Datei, und falls dort nicht gefunden, relativ zum aktuellen Verzeichnis, in dem
autogsdoc läuft, und schließlich relativ zu dem Verzeichnis, das von der
Dokumentationsverzeichnis default.


Eine Zusammenfassung des Inhalts des Dokuments ... im Kopf der GSDoc-Ausgabe.


Eine Beschreibung des Autors des Codes - kann wiederholt werden, um den Fall zu behandeln, in dem a
Dokument hat mehrere Autoren. Im Kopf der GSDoc-Ausgabe platziert. Als Hilfestellung
Lesbarkeit der Quelle, einige spezielle zusätzliche Verarbeitungen werden in Bezug auf
der Autor des Dokuments - Jede Zeile der Form 'Autor: Name ', oder von:
Name ', oder 'Autor: Name' oder 'Von: Name' werden erkannt und
umgewandelt in an Autor Element, möglicherweise enthaltend ein E-Mail Element.


Wird in der GSDoc-Ausgabe kurz vor dem Ende des Hauptteils des Dokuments platziert - beabsichtigt
für Anhänge, Index etc. zu verwenden.


Unmittelbar vor jeder generierten Klassendokumentation platziert ... zur Verwendung vorgesehen
um eine allgemeine Beschreibung der Funktionsweise des dokumentierten Codes bereitzustellen. Irgendein
Dokumentation für die main()-Funktion eines Programms wird als Abschnitt am Ende eingefügt
dieses Kapitels.


Copyright des Inhalts des Dokuments ... im Kopf der GSDoc-Ausgabe platziert.
Um die Lesbarkeit der Quelle zu erleichtern, sind einige spezielle Zusatzbearbeitungen
durchgeführt - Jede Zeile der Form 'Copyright (C) Text' wird erkannt und konvertiert
zum Kopieren Element.


Datum der Überarbeitung des Dokuments ... im Kopf der GSDoc-Ausgabe platziert. Wenn
Wird dies weggelassen, versucht das Tool, einen Wert aus dem RCS-Datums-Tag zu erstellen (wenn
verfügbar).


Wird am Anfang des Hauptteils in das Dokument eingefügt ... soll vorsehen
Einführungs- oder Inhaltsseiten etc.


Titel des Dokuments ... im Kopf der GSDoc-Ausgabe platziert. Wenn dies weggelassen wird
das Tool generiert einen eigenen (wahrscheinlich schlechten) Titel - also sollten Sie diesen einfügen
manuell markieren.


Versionskennung des Dokuments ... im Kopf der GSDoc-Ausgabe platziert. Wenn
Wird dies weggelassen, versucht das Tool, einen Wert aus dem RCS-Revisions-Tag zu erstellen (wenn
verfügbar).

NB Das gerade beschriebene Markup kann in der Klassen-, Kategorie- oder Protokolldokumentation verwendet werden
... wenn ja, wird es extrahiert und um den Rest der Dokumentation für die Klasse gewickelt
als Kapitel der Klasse. Der Rest der Klassendokumentation wird normalerweise am
Ende des Kapitels, kann aber stattdessen anstelle des Pseudo-
Element innerhalb der Element.

METHODE AUSZEICHNUNG

In Kommentaren, die verwendet werden, um Text für eine Methodenbeschreibung bereitzustellen, ist das folgende Markup
aus dem Text entfernt und speziell behandelt -


Die Methode wird als designierter Initialisierer für die Klasse markiert.


Die Methode ist als eine Methode gekennzeichnet, die von Unterklassen überschrieben werden muss (z
Methode).


Die Methode ist als eine Methode gekennzeichnet, die von Unterklassen ausgehen sollte NICHT überschreiben.


Das Markup wird aus der Beschreibung entfernt und platziert nachdem es in der GSDoc-Ausgabe -
so dass die Methode als konform (oder nicht konform) zu den spezifizierten beschrieben wird
Standards.

AUTOMATISCH AUSZEICHNUNG

Im Allgemeinen wird der Text in Kommentaren neu formatiert, um ihn zu standardisieren und gut einzurücken ...
Neuformatierung ist nicht für jeden Text innerhalb von an . ausgeführt Element. Wenn der Text ist
neu formatiert, wird es in durch Leerzeichen getrennte „Wörter“ unterteilt, die dann
etwas zusätzliche Verarbeitung...

Bestimmte bekannte Konstanten wie YES, NO und nil sind eingeschlossen in ...
Markup.

Die Namen von Methodenargumenten in Methodenbeschreibungen sind in ...
</ var> Markup.

Methodennamen (beginnend mit einem Plus- oder Minuszeichen) sind in eingeschlossen ...
Markup. ZB würde "-init" (ohne Anführungszeichen) in eine GSDoc-Referenz eingeschlossen
-Element auf die init-Methode der aktuellen Klasse zeigen oder, wenn nur eine bekannte Klasse
eine init-Methode hätte, würde sie sich auf die Methode dieser Klasse beziehen. Beachten Sie die Tatsache, dass
der Methodenname muss von Leerzeichen umgeben sein, um erkannt zu werden (obwohl ein Komma,
Punkt oder Semikolon am Ende des Bezeichners verhält sich wie ein Leerzeichen).

Methodenspezifizierer einschließlich Klassennamen (beginnend und endend mit eckigen Klammern)
sind eingeschlossen in ... Markup. zB '[NSObject-init]', erstellt a
Verweis auf die init-Methode von NSObject (entweder die eigentliche Klasse oder eine ihrer
Kategorien), während '[(NSCopying)-copyWithZone:]' eine Referenz auf eine Methode in . erstellt
das NSCopying-Protokoll. Beachten Sie, dass zwischen den eckigen Klammern keine Leerzeichen stehen dürfen
in diesen Bezeichnern. Protokollnamen werden in runde Klammern anstatt in die
übliche spitze Klammern, da GSDoc eine XML-Sprache ist und XML Winkel behandelt
Klammern speziell.

Funktionsnamen (die mit '()' enden) andere als 'main()' sind eingeschlossen in ...
Markup. ZB "NSLogv()" (ohne die Anführungszeichen) würde in ein GSDoc verpackt
Referenzelement, um auf die Dokumentation der NSLog-Funktion zu verweisen. Beachten Sie die Tatsache
dass der Funktionsname von Leerzeichen umgeben sein muss (obwohl ein Komma, ein Punkt oder
Semikolon am Ende des Bezeichners fungiert auch als Whitespace-Abschlusszeichen).

ARGUMENTE UND STANDARDS

Das Tool akzeptiert bestimmte Benutzervorgaben (die natürlich als Befehlszeile bereitgestellt werden können
Argumente, indem Sie dem Standardnamen '-' voranstellen und den Wert danach angeben, wie in
-Reinigen JA):

Clean
Wenn dieser boolesche Wert auf YES gesetzt ist, wird keine Dokumentation erstellt, die
Tool entfernt alle im Projekt generierten GSDoc-Dateien und alle generierten HTML-Dateien
aus ihnen (sowie alle, die aus aufgelisteten GSDoc-Dateien generiert würden)
explizit) und entfernt schließlich die Projektindexdatei. Die einzige Ausnahme hiervon
sind diese GSDoc-Vorlagendateien (dh diejenigen, die mit "-ConstantsTemplate ..."
"-FunctionsTemplate ..." Argumente usw.) werden nicht gelöscht, es sei denn, die CleanTemplates
Flagge ist gesetzt.

Saubere Vorlagen
Dieses Flag gibt an, ob Vorlagen-GSDoc-Dateien zusammen mit anderen entfernt werden sollen
Dateien, wenn die Clean-Option angegeben ist. Standardmäßig werden sie nicht entfernt
... da diese Vorlagen möglicherweise manuell erstellt wurden und nur Daten eingefügt wurden
in sie.

KonstantenVorlage
Geben Sie den Namen eines Vorlagendokuments an, in das die Dokumentation über Konstanten
sollte aus allen Dateien im Projekt eingefügt werden. Dies ist nützlich, wenn Konstanten im
Quellcode ist über viele Dateien verstreut, und Sie müssen sie in einer gruppieren
Platz. Sie sind dafür verantwortlich, dass das grundlegende Vorlagendokument (in das
individuelle ständige Dokumentation eingefügt wird) enthält alle weiteren Informationen, die Sie
wollen, aber der Einfachheit halber generiert autogsdoc eine einfache Vorlage (die Sie
dann bearbeiten) für Sie, wenn die Datei nicht existiert. Das Einfügen erfolgt sofort
Vor dem Zurück -Element (oder falls dieses nicht existiert, unmittelbar vor dem Ende des
Körper Element) in der Vorlage.

Erklärt
Geben Sie an, wo Überschriften als gefunden dokumentiert werden sollen. Der eigentliche Name produziert
in der Dokumentation wird durch Anhängen der letzten Komponente des Header-Dateinamens gebildet
auf den Wert dieser Vorgabe. Wenn dieser Standardwert nicht angegeben ist, wird der vollständige Name des
Header-Datei (wie in der Befehlszeile bereitgestellt), mit dem HeaderDirectory-Standard
vorangestellt, verwendet wird. Eine typische Verwendung dafür könnte '"-Declared Foundation"' sein, wenn
Generieren von Dokumentation für die GNUstep-Basisbibliothek. Dies würde dazu führen, dass
Dokumentation, die besagt, dass NSString in 'Foundation/NSString.h' deklariert ist

DocumentAllInstanceVariables
Mit diesem Flag können Sie eine Dokumentation für alle Instanzvariablen erstellen. Normalerweise,
nur die explizit als 'öffentlich' oder 'geschützt' deklarierten werden dokumentiert.

DocumentInstanceVariables
Mit diesem Flag können Sie die Dokumentation für Instanzvariablen vollständig deaktivieren.
Normalerweise werden explizit als 'öffentlich' oder 'geschützt' deklarierte Instanzvariablen
Dokumentiert.

InstanzVariablenAtEnd
Wenn dieses Flag gesetzt ist, weist der HTML-Generator an, die Dokumentation der Instanzvariablen zu platzieren
am Ende der Klasse, statt am Anfang. Dies ist nützlich, wenn Sie viele
geschützte Instanzvariablen, die nur von untergeordnetem Interesse sind
allgemeine Benutzer der Klasse.

Dokumentationsverzeichnis
Kann verwendet werden, um das Verzeichnis anzugeben, in dem die generierte Dokumentation abgelegt werden soll.
Ist dies nicht gesetzt, wird die Ausgabe im aktuellen Verzeichnis abgelegt. Dieses Verzeichnis ist auch
als letzter Ausweg verwendet, um Quelldateien (nicht Header) zu finden, und was noch wichtiger ist, es
wird als die verwendet zuerst und einzige Suchen Sie alle .gsdoc-Dateien, die weitergegeben werden
die Befehlszeile. Alle Pfadangaben für diese Dateien sind entfernt und sie sind
in 'DocumentationDirectory' gesucht (auch wenn sie möglicherweise nicht
automatisch generiert).

Mappen
Gibt den Namen einer Datei an, die eine Liste von Dateinamen als Eigenschaftslisten-Array enthält
(Name1,Name2,...) Format. Wenn diese vorhanden ist, werden Dateinamen in der Programmargumentliste
werden ignoriert und die Namen in dieser Datei werden als Liste der zu verarbeitenden Namen verwendet.

FunktionenVorlage
Geben Sie den Namen eines Vorlagendokuments an, in das die Dokumentation über Funktionen
sollte aus allen Dateien im Projekt eingefügt werden. Dies ist nützlich, wenn die Funktionsquelle
Code ist über viele Dateien verstreut, und Sie müssen ihn an einem Ort gruppieren. Sie sind
dafür verantwortlich, dass das grundlegende Vorlagendokument (in welches einzelne
Funktionsdokumentation eingefügt) enthält alle anderen gewünschten Informationen, aber
aus praktischen Gründen generiert autogsdoc eine einfache Vorlage (die Sie dann bearbeiten können)
für Sie, wenn die Datei nicht existiert. Die Einfügung erfolgt unmittelbar vor dem Zurück
-Element (oder falls dieses nicht existiert, unmittelbar vor dem Ende des Körper Element) in
Die Vorlage.

HTML generieren
Kann verwendet werden, um anzugeben, ob eine HTML-Ausgabe generiert werden soll. Standardmäßig ist JA.

HeaderVerzeichnis
Kann verwendet werden, um das Verzeichnis anzugeben, das nach Header-Dateien durchsucht werden soll. Bei Lieferung,
dieser Wert wird den relativen Headernamen vorangestellt, andernfalls die relativen Headernamen
werden relativ zum aktuellen Verzeichnis interpretiert. Header-Dateien als absolut angegeben
Pfade werden von dieser Vorgabe nicht beeinflusst.

Abhängigkeiten ignorieren
Ein boolescher Wert, der verwendet werden kann, um anzugeben, dass das Programm Datei ignorieren soll
Änderungszeiten und Dateien trotzdem neu generieren. Zur Verwendung in Verbindung mit . vorgesehen
das 'make'-System, von dem erwartet wird, dass es die Abhängigkeitsprüfung selbst verwaltet.

LokaleProjekte
Dieser Wert wird verwendet, um die automatische Aufnahme lokaler externer Projekte in
das Indexierungssystem zur Generierung von Querverweisen in der endgültigen Dokumentenausgabe. Wenn
auf 'Keine' gesetzt, dann werden keine lokalen Projektreferenzen erstellt, andernfalls wird die 'Lokal'
Das GNUstep-Dokumentationsverzeichnis wird rekursiv nach Dateien mit einer '.igsdoc' durchsucht
Erweiterung, und die Indizierungsinformationen dieser Dateien werden verwendet. Der Wert dieser
string wird auch verwendet, um die Dateinamen im Querverweis zu generieren ... wenn es ein
leerer String, wird angenommen, dass der zu verwendende Pfad eine Datei im selben Verzeichnis ist, in dem die
igsdoc-Datei gefunden wurde, andernfalls wird sie als Präfix für den Namen im Index verwendet. Achtung.
Lokale Projekte mit demselben Namen wie das aktuell dokumentierte Projekt werden nicht
von diesem Mechanismus erfasst werden. Wenn Sie solche Projekte einbeziehen möchten, müssen Sie dies tun
explizit verwenden -Projekte ...

MakrosVorlage
Geben Sie den Namen eines Vorlagendokuments an, in das die Dokumentation zu Makros eingefügt werden soll
aus allen Dateien im Projekt eingefügt werden. Dies ist nützlich, wenn Makrocode verstreut ist
um viele Dateien herum, und Sie müssen sie an einem Ort gruppieren. Du bist verantwortlich für
sicherzustellen, dass das grundlegende Vorlagendokument (in das die individuelle Makrodokumentation
eingefügt wird) enthält alle anderen gewünschten Informationen, aber der Einfachheit halber
autogsdoc generiert eine einfache Vorlage (die Sie dann bearbeiten können), wenn die
Die Datei existiert nicht. Die Einfügung erfolgt unmittelbar vor dem Zurück Element (oder wenn
das gibt es nicht, unmittelbar vor dem ende des Körper
Element) in der Vorlage.

Abhängigkeiten erstellen
Ein Dateiname, der verwendet werden soll, um Abhängigkeitsinformationen für make auszugeben. Das dauert die
Form der Auflistung aller Header- und Quelldateien, die für das Projekt als Abhängigkeiten von . bekannt sind
den Projektnamen (siehe 'Projekt').

Projekt
Kann verwendet werden, um den Namen dieses Projekts anzugeben ... bestimmt den Namen des Index
Referenzdatei, die als Teil der Dokumentation erstellt wurde, um Informationen bereitzustellen, die es ermöglichen
andere Projekte, um Querverweise auf Elemente in diesem Projekt zu erstellen.

Projekte
Dieser Wert kann als Wörterbuch mit den Pfaden zum igsdoc bereitgestellt werden
Index-/Referenzdateien, die von externen Projekten verwendet werden, zusammen mit Werten, die zum Zuordnen verwendet werden
die in den Indizes gefundenen Dateinamen. Wenn beispielsweise eine Projektindexdatei (igsdoc)
sagt, dass die Klasse 'Foo' in der Datei 'Foo' gefunden wird und der zugehörige Pfad
dieser Projektindex ist '/usr/share/doc/proj', dann kann die generierte HTML-Ausgabe verweisen
die Klasse als in '/usr/share/doc/prj/Foo.html' befindlich. Beachten Sie, dass ein Wörterbuch möglicherweise
in der Befehlszeile unter Verwendung des Standard-PropertyList-Formats (nicht des XML
Format von OS X), Semikolons als Zeilentrenner verwenden und in einzelnes einschließen
Zitate.

Abhängigkeiten anzeigen
Ein boolescher Wert, der verwendet werden kann, um anzugeben, dass das Programm welche Dateien protokollieren soll
werden aufgrund ihrer Abhängigkeiten von anderen Dateien neu generiert.

Normen
Ein boolescher Wert, der verwendet wird, um anzugeben, ob das Programm Informationen über . einfügen soll
Normenkonformität in die Dokumentation. Dies sollte nur verwendet werden, wenn
Dokumentation der GNUstep-Bibliotheken und -Tools selbst, da davon ausgegangen wird, dass der Code
zu dokumentieren ist Teil von GNUstep und entspricht möglicherweise dem OpenStep-Standard
oder implementiert MacOS-X-kompatible Methoden.

SystemProjekte
Dieser Wert wird verwendet, um die automatische Einbeziehung von systemexternen Projekten in
das Indexierungssystem zur Generierung von Querverweisen in der endgültigen Dokumentenausgabe. Wenn
auf 'Keine' gesetzt, dann werden keine Systemprojektreferenzen erstellt, andernfalls wird das 'System'
Das GNUstep-Dokumentationsverzeichnis wird rekursiv nach Dateien mit einer '.igsdoc' durchsucht
Erweiterung, und die Indizierungsinformationen dieser Dateien werden verwendet. Der Wert dieser
string wird auch verwendet, um die Dateinamen im Querverweis zu generieren ... wenn es ein
leerer String, wird angenommen, dass der zu verwendende Pfad eine Datei im selben Verzeichnis ist, in dem die
igsdoc-Datei gefunden wurde, andernfalls wird sie als Präfix für den Namen im Index verwendet. Achtung.
Systemprojekte mit demselben Namen wie das aktuell dokumentierte Projekt werden nicht
von diesem Mechanismus erfasst werden. Wenn Sie solche Projekte einbeziehen möchten, müssen Sie dies tun
explizit verwenden -Projekte ...

TypdefsVorlage
Geben Sie den Namen eines Vorlagendokuments an, in das die Dokumentation über Typedefs eingefügt werden soll
aus allen Dateien im Projekt eingefügt werden. Dies ist nützlich, wenn typedef-Quellcode
über viele Dateien verstreut, und Sie müssen sie an einem Ort gruppieren. Sie sind
dafür verantwortlich, dass das grundlegende Vorlagendokument (in welches einzelne
typedef-Dokumentation eingefügt) enthält alle anderen gewünschten Informationen, aber wie
ein bequemes autogsdoc generiert eine einfache Vorlage (die Sie dann bearbeiten können) für
Sie, wenn die Datei nicht existiert. Die Einfügung erfolgt unmittelbar vor dem Zurück
-Element (oder falls dieses nicht existiert, unmittelbar vor dem Ende des Körper Element) in
Die Vorlage.

Up Eine Zeichenfolge, die verwendet wird, um den Namen bereitzustellen, der im 'Up'-Link vom generierten GSDoc verwendet werden soll
Unterlagen. Dies sollte normalerweise der Name einer Datei sein, die einen Index der
Inhalte eines Projekts. Wenn dieser fehlt oder auf einen leeren String gesetzt ist, dann kein 'up'
Link wird in den Dokumenten zur Verfügung gestellt.

VariablenVorlage
Geben Sie den Namen eines Vorlagendokuments an, in das die Dokumentation zu Variablen
sollte aus allen Dateien im Projekt eingefügt werden. Dies ist nützlich, wenn variable Quelle
Code ist über viele Dateien verstreut, und Sie müssen ihn an einem Ort gruppieren. Sie sind
dafür verantwortlich, dass das grundlegende Vorlagendokument (in welches einzelne
variable Dokumentation eingefügt) enthält alle anderen gewünschten Informationen, aber
aus praktischen Gründen generiert autogsdoc eine einfache Vorlage (die Sie dann bearbeiten können)
für Sie, wenn die Datei nicht existiert. Die Einfügung erfolgt unmittelbar vor dem Zurück
-Element (oder falls dieses nicht existiert, unmittelbar vor dem Ende des Körper Element) in
Die Vorlage.

Ausführlich
Ein boolescher Wert, der verwendet wird, um anzugeben, ob eine ausführliche Debug-/Warnausgabe ausgegeben werden soll
produziert.

Warnen
Ein boolescher Wert, der verwendet wird, um anzugeben, ob Sie eine Standard-Warnausgabe wünschen (z. B. Bericht von
undokumentierte Methoden) produziert.

Weltkarte
Dieser Wert ist ein Wörterbuch, das verwendet wird, um in den Quelldateien gefundene Bezeichner/Schlüsselwörter zuzuordnen
zu anderen Worten. Im Allgemeinen müssen Sie dies nicht verwenden, aber es ist manchmal hilfreich
um zu vermeiden, dass der Parser durch die Verwendung von C-Präprozessormakros verwirrt wird. Du kannst
Definieren Sie das Makro effektiv zu etwas weniger Verwirrung. Der Wert, den Sie abbilden
Bezeichner to muss einer sein - ein anderer Bezeichner, eine leere Zeichenfolge - der Wert ist
ignoriert, zwei Schrägstriche ('//') - der Rest der Zeile wird ignoriert. Beachten Sie, dass ein Wörterbuch
kann in der Befehlszeile unter Verwendung des standardmäßigen PropertyList-Formats (nicht des
XML-Format von OS X), verwendet Semikolons als Zeilentrenner und umschließt es in einzelne
Zitate.

INTER-DOKUMENT LINKAGE

Die Standardeinstellung 'Up' wird verwendet, um den Namen eines Dokuments anzugeben, das als
'Up'-Link für alle anderen verwendeten Dokumente. Dieser Name darf keinen Pfad oder keine Erweiterung enthalten.
Im Allgemeinen sollte das Dokument, auf das sich dieser Standard bezieht, ein handbearbeitetes GSDoc-Dokument sein
die einen hinteren Abschnitt haben sollte, der einen Projektindex enthält. z.B

<? Xml version = "1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.3//EN"
"http://www.gnustep.org/gsdoc-1_0_3.xml">


Meine Projektreferenz




Meine Projektreferenz

Verwenden Sie autogsdoc online mit den onworks.net-Diensten