autogsdoc - Online in de cloud

PROGRAMMA:

NAAM

autogsdoc - GNUstep API-documentatiegenerator en XML->HTML-converter

KORTE INHOUD

autogsdoc [-Bestanden bestandsnaam] [-Genereer HTML JA|nee] [-Schoon ja|NEE] [-Schone sjablonen
ja|NEE] [- Negeer afhankelijkheden ja|NEE] [-Maak afhankelijkheden ja|NEE] [-Toon afhankelijkheden ja|NEE]
[-HeaderDirectory pad] [-DocumentatieDirectory pad] [-Verklaard plaats] [-Project
titel] [-Normen ja|NEE] [-DocumentAllInstanceVariabelen ja|NEE]
[-DocumentInstanceVariabelen JA|nee] [-InstanceVariablesAtEnd ja|NEE] [-Constantensjabloon
bestandsnaam] [-Functiesjabloon bestandsnaam] [-Macro-sjabloon bestandsnaam] [-Typedefs-sjabloon
bestandsnaam] [-Variabelensjabloon bestandsnaam] [-Systeemprojecten snaar] [-Lokale projecten snaar]
[-Projecten dictString] [Verbaasd ja|NEE] [-Waarschuwen ja|NEE] [-Woordkaart dictString] [bestanden]

PRODUCTBESCHRIJVING

De autogsdoc-tool is een opdrachtregelhulpprogramma waarmee ontwikkelaars referenties kunnen maken
documentatie voor GNUstep API's. Het stelt ontwikkelaars ook in staat om andere te schrijven en te onderhouden
documentatie in XML en laat deze converteren naar HTML. In detail zal autogsdoc:

- Extraheer speciale opmerkingen die de openbare interfaces van klassen, categorieën,
protocollen, functies en macro's uit Objective C-broncode (headerbestanden en
optioneel bronbestanden) in GSDoc XML-bestanden.

- Converteer GSDoc XML-bestanden, ongeacht of deze zijn gegenereerd vanuit de broncode of handmatig zijn geschreven door
ontwikkelaars, in HTML.

- Construeer indexen op basis van GSDoc XML-bestandssets en converteer deze ook naar HTML.

Het meest voorkomende gebruik hiervan is om de opdracht uit te voeren met een of meer headerbestandsnamen als
argumenten ... de tool parseert automatisch de overeenkomstige bronbestanden daarin
map als headers (of de huidige map, of de map die is opgegeven met behulp van de
DocumentationDirectory standaard), en produceer GSDoc- en HTML-bestanden als uitvoer. Voor het beste
resultaten Deze modus moet worden uitgevoerd vanuit de map die de bronbestanden bevat. (Opmerking
dat, aangezien C een subset is van Doelstelling C, dit hulpmiddel kan dienen om functies en functies te documenteren
andere C-structuren in gewone C-bron.)

GSDoc-bestanden kunnen ook direct als aanvulling of op zichzelf worden opgegeven en worden geconverteerd
naar HTML. Zie de GSDoc HTML-documentatie of de gsdoc(7) manpagina voor informatie over de
GSDoc-formaat.

Ten slotte kunnen HTML-bestanden op de opdrachtregel worden weergegeven. Kruisverwijzingen naar andere delen van
codedocumentatie die daarin wordt gevonden, wordt herschreven op basis van wat er in de
project momenteel.

BRON CODE MARKUP

De broncodeparser zal automatisch GSDoc-documenten produceren met daarin de methoden
de klassen gevonden in de bronbestanden, en het zal tekst bevatten van speciaal opgemaakte bestanden
opmerkingen uit de bronbestanden.

Elke opmerking die begint met een schuine streep en twee sterretjes in plaats van de gewone schuine streep en single
asterisk, wordt gezien als GSDoc-markering, om te gebruiken als de beschrijving van de klasse of methode
het volgen. Deze commentaartekst wordt opnieuw opgemaakt en vervolgens in de uitvoer ingevoegd.
Wanneer meerdere opmerkingen aan hetzelfde item zijn gekoppeld, worden ze samengevoegd met een
regeleinde ( ) tussen elk, indien nodig.

De tool kan eenvoudig worden gebruikt om zowel programma's als bibliotheken te documenteren, simpelweg door deze in te voeren
de naam van het bronbestand dat de functie main() van het programma bevat - het heeft de
speciale opmerkingen van die functie en behandelt ze speciaal, door ze in te voegen als een
sectie aan het einde van het eerste hoofdstuk van het document (het creëert het eerste hoofdstuk als
vereist).

Opties worden beschreven in de sectie argumenten en Standaardwaarden hieronder.

EXTRA MARKUP

Er zijn enkele gevallen waarin speciale extra bewerkingen worden uitgevoerd, voornamelijk in de
eerste opmerking gevonden in het bronbestand, waaruit verschillende delen van GSDoc-opmaak kunnen bestaan
geëxtraheerd en op de juiste locaties in het uitvoerdocument geplaatst -

AutogsdocBron:
In welke lijn dan ook AutogsdocBron: wordt gevonden, wordt de rest van de lijn genomen als a
bronbestandsnaam moet worden gebruikt in plaats van ervan uit te gaan dat elk .h-bestand
verwerkt maakt gebruik van een .m-bestand met dezelfde naam. U mag er meerdere aanleveren AutogsdocBron:
regels waarbij een headerbestand items declareert die in meerdere bronbestanden zijn gedefinieerd.
Als een bestandsnaam absoluut is, wordt deze gebruikt zoals opgegeven. Als het daarentegen een
relatief pad, de software zoekt eerst naar het bronbestand relatief aan de locatie
van het headerbestand, en als het daar niet wordt gevonden, relatief ten opzichte van de huidige map waarin
autogsdoc actief is, en ten slotte relatief ten opzichte van de map die is opgegeven door de
DocumentatieDirectory standaard.


Een samenvatting van de inhoud van het document... geplaatst in de kop van de GSDoc-uitvoer.


Een beschrijving van de auteur van de code kan worden herhaald om het geval af te handelen waarin a
document heeft meerdere auteurs. Geplaatst in de kop van de GSDoc-uitvoer. Als hulpmiddel bij
leesbaarheid van de bron, wordt er een speciale aanvullende bewerking uitgevoerd in verband met
de auteur van het document - Elke regel met de vorm 'Auteur: naam ', of door:
naam ', of 'Auteur: naam' of 'Door: naam' wordt herkend en
omgezet in een auteur element, dat mogelijk een email element.


Geplaatst in de GSDoc-uitvoer net voor het einde van de hoofdtekst van het document - bedoeld
te gebruiken voor bijlagen, index etc..


Direct vóór gegenereerde klassendocumentatie geplaatst... bedoeld om te worden gebruikt
om een ​​algemene beschrijving te geven van hoe de code die wordt gedocumenteerd werkt. Elk
documentatie voor de main()-functie van een programma wordt aan het einde als sectie ingevoegd
van dit hoofdstuk.


Copyright van de inhoud van het document ... geplaatst in de kop van de GSDoc-uitvoer.
Ter bevordering van de leesbaarheid van de bron is er sprake van een bijzondere aanvullende bewerking
uitgevoerd - Elke regel in de vorm 'Copyright (C)-tekst' wordt herkend en geconverteerd
een kopiëren element.


Datum van revisie van het document ... geplaatst in de kop van de GSDoc-uitvoer. Als
Als dit wordt weggelaten, zal het hulpprogramma proberen een waarde uit de RCS Date-tag te construeren (if
beschikbaar).


Ingevoegd in het document aan het begin van de hoofdtekst ... bedoeld om te voorzien
introductie- of inhoudspagina's etc.


Titel van het document ... geplaatst in de kop van de GSDoc-uitvoer. Als dit achterwege blijft
de tool genereert zelf een (waarschijnlijk slechte) titel - dus je moet deze opnemen
handmatig opmaken.


Versie-identificatie van het document ... geplaatst in de kop van de GSDoc-uitvoer. Als
Als dit wordt weggelaten, zal het hulpprogramma proberen een waarde uit de RCS Revision-tag te construeren (if
beschikbaar).

NB De zojuist beschreven opmaak kan worden gebruikt binnen klasse-, categorie- of protocoldocumentatie
... als dat zo is, wordt het geëxtraheerd en rond de rest van de documentatie voor de klasse gewikkeld
als hoofdstuk van de klas. De rest van de klassedocumentatie wordt normaal gesproken ingevoegd in het
einde van het hoofdstuk, maar kan in plaats daarvan worden vervangen door de pseudo-
onderdeel binnen de element.

METHODE MARKUP

In opmerkingen die worden gebruikt om tekst te leveren voor een methodebeschrijving, is de volgende opmaak
uit de tekst verwijderd en speciaal behandeld -


De methode wordt gemarkeerd als de aangewezen initialisator voor de klasse.


De methode is gemarkeerd als een methode die door subklassen moet worden overschreven (bijvoorbeeld een abstract
methode).


De methode is gemarkeerd als een methode die door subklassen zou moeten worden gebruikt NIET overschrijven.


De opmaak wordt uit de beschrijving verwijderd en geplaatst na het in de GSDoc-uitvoer -
zodat de methode wordt beschreven als conform (of niet conform) aan het gespecificeerde
normen.

AUTOMATISCHE MARKUP

Over het algemeen wordt de tekst in opmerkingen opnieuw opgemaakt om deze te standaardiseren en mooi te laten inspringen ... de
herformatteren is niet uitgevoerd op elke tekst binnen een element. Wanneer de tekst is
opnieuw geformatteerd, wordt het opgesplitst in door witruimte gescheiden “woorden” waaraan vervolgens wordt onderworpen
wat extra bewerking...

Bepaalde bekende constanten zoals JA, NEE en nul zijn ingesloten in ...
opmaak.

De namen van methodeargumenten binnen methodebeschrijvingen staan ​​tussen ...
</ var> opmaak.

Methodenamen (beginnend met een plus of min) zijn ingesloten ...
opmaak. "-init" (zonder de aanhalingstekens) zou bijvoorbeeld in een GSDoc-referentie worden verpakt
element dat verwijst naar de init-methode van de huidige klasse of, als er maar één bekende klasse is
een init-methode had, zou deze verwijzen naar de methode van die klasse. Let op het feit dat
de naam van de methode moet omgeven zijn door witruimte om herkend te worden (hoewel een komma,
punt of puntkomma aan het einde van de specificatie fungeert als witruimte).

Methodespecificaties inclusief klassenamen (beginnend en eindigend met vierkante haakjes)
zijn ingesloten ... opmaak. bijvoorbeeld '[NSObject-init]', zal een
verwijzing naar de init-methode van NSObject (ofwel de eigenlijke klasse, ofwel een van zijn
categorieën), terwijl '[(NSCopying)-copyWithZone:]' een verwijzing creëert naar een methode in
het NSCopying-protocol. Houd er rekening mee dat er geen spaties tussen de vierkante haakjes mogen staan
in deze specificaties. Protocolnamen staan ​​tussen ronde haakjes in plaats van de
gebruikelijke punthaken, omdat GSDoc een XML-taal is en XML hoek behandelt
beugels speciaal.

Functienamen (die eindigen op '()') anders dan 'main()' zijn ingesloten ...
opmaak. "NSLogv()" (zonder de aanhalingstekens) zou bijvoorbeeld in een GSDoc worden verpakt
referentie-element om naar de documentatie van de NSLog-functie te verwijzen. Let op het feit
dat de functienaam moet worden omgeven door witruimte (hoewel een komma, punt of
puntkomma aan het einde van de specificatie fungeert ook als witruimteterminator).

ARGUMENTEN EN STANDAARD

De tool accepteert bepaalde standaardinstellingen van de gebruiker (die uiteraard als opdrachtregel kunnen worden opgegeven).
argumenten door '-' voor de standaardnaam te zetten en daarna de waarde op te geven, zoals in
-Schoon JA):

Schoon
Als deze Booleaanse waarde is ingesteld op YES, wordt er geen documentatie gegenereerd, maar wordt de
tool verwijdert alle GSDoc-bestanden die in het project zijn gegenereerd, en alle gegenereerde HTML-bestanden
van hen (evenals alle bestanden die zouden worden gegenereerd op basis van de vermelde GSDoc-bestanden
expliciet), en verwijdert uiteindelijk het projectindexbestand. De enige uitzondering hierop
is dat sjabloon GSDoc-bestanden (dat wil zeggen die gespecificeerd met "-ConstantsTemplate ...",
"-FunctionsTemplate..." argumenten enz.) worden niet verwijderd, tenzij CleanTemplates
vlag is gezet.

Schone sjablonen
Deze vlag geeft aan of sjabloon-GSDoc-bestanden samen met andere moeten worden verwijderd
bestanden wanneer de optie Opschonen is opgegeven. De standaardinstelling is dat ze niet worden verwijderd
... aangezien deze sjablonen mogelijk handmatig zijn geproduceerd en er alleen gegevens zijn ingevoegd
in hen.

Constantensjabloon
Geef de naam op van een sjabloondocument waarin documentatie over constanten wordt opgenomen
moet uit alle bestanden in het project worden ingevoegd. Dit is handig als constanten in de
broncode zijn verspreid over veel bestanden en u moet ze in één groep groeperen
plaats. U bent ervoor verantwoordelijk dat het basissjabloondocument (waarin
individuele constante documentatie is ingevoegd) bevat alle andere informatie die u nodig heeft
wilt, maar voor uw gemak zal autogsdoc een eenvoudig sjabloon genereren (wat u ook kunt doen).
dan bewerken) voor u als het bestand niet bestaat. Het inbrengen vindt onmiddellijk plaats
voor de terug element (of als dat niet bestaat, onmiddellijk voor het einde van de
lichaam element) in de sjabloon.

Verklaard
Geef op waar headers moeten worden gedocumenteerd als gevonden. De werkelijke naam geproduceerd
in de documentatie wordt gevormd door het toevoegen van het laatste onderdeel van de headerbestandsnaam
tot de waarde van deze standaard. Als deze standaard niet is opgegeven, wordt de volledige naam van het
header-bestand (zoals opgegeven op de opdrachtregel), met de standaard HeaderDirectory
voorafgegaan, wordt gebruikt. Een typisch gebruik hiervan zou '-Declared Foundation' kunnen zijn wanneer
het genereren van documentatie voor de GNUstep-basisbibliotheek. Dit zou resulteren in de
documentatie waarin staat dat NSString is gedeclareerd in 'Foundation/NSString.h'

DocumentAllInstanceVariabelen
Met deze vlag kunt u documentatie genereren voor alle instantievariabelen. Normaal gesproken,
alleen diegene die expliciet 'openbaar' of 'beschermd' zijn verklaard, zullen worden gedocumenteerd.

DocumentInstanceVariabelen
Met deze vlag kunt u documentatie, bijvoorbeeld variabelen, volledig uitschakelen.
Normaal gesproken zijn expliciet gedeclareerde 'openbare' of 'beschermde' instantievariabelen dat wel
gedocumenteerd.

InstanceVariablesAtEnd
Deze vlag, indien ingesteld, zorgt ervoor dat de HTML-generator documentatie over instancevariabelen plaatst
aan het einde van de les, in plaats van aan het begin. Dit is handig als je er veel van gebruikt
beschermde instantievariabelen die alleen van secundair belang zijn
algemene gebruikers van de klas.

DocumentatieDirectory
Kan worden gebruikt om de directory op te geven waarin de gegenereerde documentatie moet worden geplaatst.
Als dit niet is ingesteld, wordt de uitvoer in de huidige map geplaatst. Deze map is ook
gebruikt als laatste redmiddel om bronbestanden (geen headers) te lokaliseren, en nog belangrijker, het
wordt gebruikt als de eerste en Slechts toevlucht nemen tot het lokaliseren van eventuele .gsdoc-bestanden die worden doorgegeven
de opdrachtregel. Alle padinformatie die voor deze bestanden wordt gegeven, is verwijderd en zij zijn
gezocht in 'DocumentationDirectory' (ook al was dat misschien niet het geval).
automatisch gegenereerd).

Bestanden
Specificeert de naam van een bestand dat een lijst met bestandsnamen bevat als een eigenschappenlijstarray
(naam1,naam2,...) formaat. Als dit aanwezig is, worden de bestandsnamen in de lijst met programmaargumenten weergegeven
worden genegeerd en de namen in dit bestand worden gebruikt als de lijst met te verwerken namen.

FunctiesSjabloon
Geef de naam op van een sjabloondocument waarin documentatie over functies is opgenomen
moet uit alle bestanden in het project worden ingevoegd. Dit is handig als functiebron
code is verspreid over veel bestanden en u moet deze op één plaats groeperen. Jij bent
verantwoordelijk om ervoor te zorgen dat het basissjabloondocument (in welke persoon
functiedocumentatie is ingevoegd) bevat alle andere informatie die u wilt, maar
voor uw gemak genereert autogsdoc een eenvoudige sjabloon (die u vervolgens kunt bewerken)
voor u als het bestand niet bestaat. Het inbrengen vindt plaats onmiddellijk vóór de terug
element (of als dat niet bestaat, onmiddellijk voor het einde van de lichaam element) in
het sjabloon.

Genereer HTML
Kan worden gebruikt om aan te geven of HTML-uitvoer moet worden gegenereerd. Standaard ingesteld op JA.

HeaderDirectory
Kan worden gebruikt om de map op te geven waarin naar headerbestanden moet worden gezocht. Wanneer geleverd,
deze waarde wordt vóór de relatieve headernamen gezet, anders de relatieve headernamen
worden geïnterpreteerd ten opzichte van de huidige map. Headerbestanden gespecificeerd als absoluut
paden worden niet beïnvloed door deze standaard.

Negeer afhankelijkheden
Een Booleaanse waarde die kan worden gebruikt om aan te geven dat het programma het bestand moet negeren
wijzigingstijden en toch bestanden opnieuw genereren. Aangeboden voor gebruik in combinatie met
het 'make'-systeem, waarvan wordt verwacht dat het de afhankelijkheidscontrole zelf beheert.

Lokale projecten
Deze waarde wordt gebruikt om de automatische opname van lokale externe projecten in te regelen
het indexeringssysteem voor het genereren van kruisverwijzingen in de uiteindelijke documentuitvoer. Als
ingesteld op 'Geen', dan worden er geen lokale projectreferenties gedaan, anders wordt de 'Lokaal'
De GNUstep-documentatiemap wordt recursief doorzocht op bestanden met een '.igsdoc'
extensie, en de indexeringsinformatie uit die bestanden wordt gebruikt. De waarde hiervan
string wordt ook gebruikt om de bestandsnamen in de kruisverwijzing te genereren ... als het een
lege tekenreeks, wordt aangenomen dat het te gebruiken pad een bestand is in dezelfde map waar de
igsdoc-bestand gevonden, anders wordt het gebruikt als voorvoegsel voor de naam in de index. Let op.
Lokale projecten met dezelfde naam als het project dat momenteel wordt gedocumenteerd, zullen dat wel doen niet
door dit mechanisme worden opgenomen. Als u dergelijke projecten wilt opnemen, moet u dat doen
expliciet gebruiken -Projecten ...

Macro'ssjabloon
Geef de naam op van een sjabloondocument waarin documentatie over macro's moet worden opgenomen
vanuit alle bestanden in het project worden ingevoegd. Dit is handig als de macrocode verspreid is
rond veel bestanden, en je moet het op één plek groeperen. Jij bent verantwoordelijk voor
ervoor zorgen dat het basissjabloondocument (waarin individuele macrodocumentatie
is ingevoegd) bevat alle andere gewenste informatie, maar dan voor uw gemak
autogsdoc genereert een eenvoudige sjabloon (die u vervolgens kunt bewerken) voor u als de
bestand bestaat niet. Het inbrengen vindt plaats onmiddellijk vóór de terug element (of als
dat bestaat niet, onmiddellijk voor het einde van de lichaam
element) in de sjabloon.

Afhankelijkheden maken
Een bestandsnaam die moet worden gebruikt om afhankelijkheidsinformatie voor make uit te voeren. Dit zal de
vorm van het opsommen van alle header- en bronbestanden waarvan bekend is dat het project afhankelijk is van
de projectnaam (zie 'Project').

Project
Kan worden gebruikt om de naam van dit project op te geven ... bepaalt de naam van de index
referentiebestand geproduceerd als onderdeel van de documentatie om informatie mogelijk te maken
andere projecten om te verwijzen naar items in dit project.

Projecten
Deze waarde kan worden geleverd als een woordenboek dat de paden naar het igsdoc bevat
index-/referentiebestanden die door externe projecten worden gebruikt, samen met waarden die moeten worden gebruikt om in kaart te brengen
de bestandsnamen die in de indexen voorkomen. Als bijvoorbeeld een projectindexbestand (igsdoc).
zegt dat de klasse 'Foo' wordt gevonden in het bestand 'Foo' en het bijbehorende pad
die projectindex is '/usr/share/doc/proj'. De gegenereerde HTML-uitvoer kan verwijzen naar
de klasse als zijnde in '/usr/share/doc/prj/Foo.html' . Merk op dat een woordenboek dat wel kan zijn
opgegeven op de opdrachtregel met behulp van het standaard PropertyList-formaat (niet het XML
formaat van OS X), waarbij puntkomma's als regelscheidingstekens worden gebruikt en deze in single worden omsloten
citaten.

Afhankelijkheden tonen
Een Booleaanse waarde die kan worden gebruikt om aan te geven dat het programma welke bestanden moet loggen
worden opnieuw gegenereerd vanwege hun afhankelijkheid van andere bestanden.

Standaarden
Een Booleaanse waarde die wordt gebruikt om aan te geven of het programma informatie moet invoegen over
naleving van standaarden in de documentatie. Dit mag alleen worden gebruikt wanneer
het documenteren van de GNUstep-bibliotheken en -tools zelf, omdat wordt aangenomen dat de code
wordt gedocumenteerd is onderdeel van GNUstep en voldoet mogelijk aan de OpenStep-standaard
of implementeert MacOS-X-compatibele methoden.

SysteemProjecten
Deze waarde wordt gebruikt om de automatische opname van externe systeemprojecten in te regelen
het indexeringssysteem voor het genereren van kruisverwijzingen in de uiteindelijke documentuitvoer. Als
ingesteld op 'Geen', dan worden er geen systeemprojectreferenties gedaan, anders wordt het 'Systeem'
De GNUstep-documentatiemap wordt recursief doorzocht op bestanden met een '.igsdoc'
extensie, en de indexeringsinformatie uit die bestanden wordt gebruikt. De waarde hiervan
string wordt ook gebruikt om de bestandsnamen in de kruisverwijzing te genereren ... als het een
lege tekenreeks, wordt aangenomen dat het te gebruiken pad een bestand is in dezelfde map waar de
igsdoc-bestand gevonden, anders wordt het gebruikt als voorvoegsel voor de naam in de index. Let op.
Systeemprojecten met dezelfde naam als het project dat momenteel wordt gedocumenteerd, zullen dat wel doen niet
door dit mechanisme worden opgenomen. Als u dergelijke projecten wilt opnemen, moet u dat doen
expliciet gebruiken -Projecten ...

TypedefsTemplate
Geef de naam op van een sjabloondocument waarin documentatie over typedefs moet worden opgenomen
vanuit alle bestanden in het project worden ingevoegd. Dit is handig als de broncode typedef is
verspreid over veel bestanden, en je moet het op één plek groeperen. Jij bent
verantwoordelijk om ervoor te zorgen dat het basissjabloondocument (in welke persoon
typedef-documentatie is ingevoegd) bevat alle andere gewenste informatie, maar as
voor het gemak genereert autogsdoc een eenvoudig sjabloon (dat u vervolgens kunt bewerken).
u als het bestand niet bestaat. Het inbrengen vindt plaats onmiddellijk vóór de terug
element (of als dat niet bestaat, onmiddellijk voor het einde van de lichaam element) in
het sjabloon.

Up Een tekenreeks die wordt gebruikt om de naam op te geven die moet worden gebruikt in de 'omhoog'-link van de gegenereerde GSDoc
documenten. Dit zou normaal gesproken de naam moeten zijn van een bestand dat een index bevat van de
inhoud van een project. Als dit ontbreekt of is ingesteld op een lege string, dan is er geen 'up'
link zal worden verstrekt in de documenten.

Variabelensjabloon
Geef de naam op van een sjabloondocument waarin documentatie over variabelen wordt opgenomen
moet uit alle bestanden in het project worden ingevoegd. Dit is handig als de bron variabel is
code is verspreid over veel bestanden en u moet deze op één plaats groeperen. Jij bent
verantwoordelijk om ervoor te zorgen dat het basissjabloondocument (in welke persoon
variabele documentatie is ingevoegd) bevat alle andere informatie die u wilt, maar
voor uw gemak genereert autogsdoc een eenvoudige sjabloon (die u vervolgens kunt bewerken)
voor u als het bestand niet bestaat. Het inbrengen vindt plaats onmiddellijk vóór de terug
element (of als dat niet bestaat, onmiddellijk voor het einde van de lichaam element) in
het sjabloon.

breedsprakig
Een booleaanse waarde die wordt gebruikt om aan te geven of u uitgebreide debug-/waarschuwingsuitvoer wilt hebben
geproduceerd.

Waarschuwen
Een booleaanse waarde die wordt gebruikt om aan te geven of u standaard waarschuwingsuitvoer wilt (bijvoorbeeld rapport van
ongedocumenteerde methoden) geproduceerd.

WordMap
Deze waarde is een woordenboek dat wordt gebruikt om identificatiegegevens/trefwoorden in de bronbestanden in kaart te brengen
met andere woorden. Over het algemeen hoeft u dit niet te gebruiken, maar soms kan het nuttig zijn
om te voorkomen dat de parser in verwarring raakt door het gebruik van C-preprocessormacro's. Jij kan
de macro effectief opnieuw definiëren tot iets minder verwarrends. De waarde die u in kaart brengt
identifier to moet een van zijn - Een andere identifier, een lege string - de waarde is
genegeerd, twee schuine strepen ('//') - de rest van de regel wordt genegeerd. Let op: een woordenboek
kan op de opdrachtregel worden opgegeven met behulp van het standaard PropertyList-formaat (niet het
XML-formaat van OS X), waarbij puntkomma's als regelscheidingstekens worden gebruikt en deze in single worden omsloten
citaten.

INTERDOCUMENT AANEENSCHAKELING

De standaardwaarde 'Omhoog' wordt gebruikt om de naam van een document op te geven dat als
'up'-link voor alle andere gebruikte documenten. Deze naam mag geen pad of extensie bevatten.
Over het algemeen moet het document waarnaar met deze standaard wordt verwezen een met de hand bewerkt GSDoc-document zijn
die een achtergedeelte moet hebben met daarin een projectindex. bijv


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


Mijn projectreferentie




Mijn projectreferentie

Gebruik autogsdoc online met behulp van onworks.net-services