gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-05-31 00:30:53 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updates to support detailed versioning of methods etc in documentation.

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@21202 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
CaS 2005-05-08 20:14:19 +00:00
parent 1c1bead0fd
commit 7cb1df3b30
10 changed files with 822 additions and 5320 deletions
Download patch file Download diff file Expand all files Collapse all files

58
Tools/gsdoc.gsdoc
View file

@ -121,7 +121,7 @@
</p>
<example>
&lt;?xml version="1.0"?&gt;
&lt;!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.6//EN" "http://www.gnustep.org/gsdoc-0_6_6.xml"&gt;
&lt;!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.2//EN" "http://www.gnustep.org/gsdoc-1_0_2.xml"&gt;
&lt;gsdoc base="MyDoc" prev="First" next="Last" up="Overview"&gt;
&lt;head&gt;
... your document head here
@ -609,7 +609,13 @@
formatted specially in output. In the majority of cases, you will
not need to write GSDoc using these elements, since they can be
autogenerated from Objective-C source files and special comments
within them. The definition elements are -
within them. Most of the elements representing parts of the API
have optional attributes ovadd and ovrem which may be used to
specify the OpenStep/OPENSTEP/MacOS-X versions at which the
documented element was added to or removed from the API, and
gvadd and gvrem which may be used to specify when an elment was
added to or removed from the GNUstep API.<br />
The definition elements are -
</p>
<deflist>
@ -626,8 +632,7 @@
zero or more <ref id="conform">conform</ref> elements,
an optional <ref id="desc">desc</ref>,
zero or more <ref id="ivariable">ivariable</ref> elements,
zero or more <ref id="method">method</ref> elements,
and an optional <ref id="standards">standards</ref> element.
zero or more <ref id="method">method</ref> elements.
</p>
</desc>
@ -643,8 +648,7 @@
<ref id="declared">declared</ref> element,
zero or more <ref id="conform">conform</ref> elements,
an optional <ref id="desc">desc</ref>,
zero or more <ref id="method">method</ref> elements,
and an optional <ref id="standards">standards</ref> element.
zero or more <ref id="method">method</ref> elements.
</p>
</desc>
@ -658,8 +662,7 @@
<ref id="declared">declared</ref> element,
zero or more <ref id="conform">conform</ref> elements,
an optional <ref id="desc">desc</ref>,
zero or more <ref id="method">method</ref> elements,
and an optional <ref id="standards">standards</ref> element.
zero or more <ref id="method">method</ref> elements.
</p>
</desc>
@ -674,8 +677,7 @@
a series of zero or more <ref id="arg">arg</ref> elements,
followed by an optional <ref id="vararg">arg</ref> element,
then an optional <ref id="declared">declared</ref> element,
an optional <ref id="desc">desc</ref>,
and an optional <ref id="standards">standards</ref> element.
an optional <ref id="desc">desc</ref>.
</p>
</desc>
@ -688,8 +690,7 @@
a series of zero or more <ref id="arg">arg</ref> elements,
followed by an optional <ref id="vararg">arg</ref> element,
then an optional <ref id="declared">declared</ref> element,
an optional <ref id="desc">desc</ref>,
and an optional <ref id="standards">standards</ref> element.
an optional <ref id="desc">desc</ref>.
</p>
</desc>
@ -700,8 +701,7 @@
<p>
The elements in a <code>&lt;macro&gt;</code> are -
an optional <ref id="declared">declared</ref> element,
an optional <ref id="desc">desc</ref>,
and an optional <ref id="standards">standards</ref> element.
an optional <ref id="desc">desc</ref>.
</p>
</desc>
@ -718,8 +718,7 @@
<p>
The elements in a <code>&lt;constant&gt;</code> are -
an optional <ref id="declared">declared</ref> element,
an optional <ref id="desc">desc</ref>,
and an optional <ref id="standards">standards</ref> element.
an optional <ref id="desc">desc</ref>.
</p>
</desc>
@ -732,8 +731,7 @@
<p>
The elements in a <code>&lt;variable&gt;</code> are -
an optional <ref id="declared">declared</ref> element,
an optional <ref id="desc">desc</ref>,
and an optional <ref id="standards">standards</ref> element.
an optional <ref id="desc">desc</ref>.
</p>
</desc>
@ -748,8 +746,7 @@
is "<code>public</code>").
<p>
The elements in a <code>&lt;variable&gt;</code> are -
an optional <ref id="desc">desc</ref>,
and an optional <ref id="standards">standards</ref> element.
an optional <ref id="desc">desc</ref>.
</p>
</desc>
@ -760,24 +757,6 @@
<ref id="definitionElements">definition elements</ref>.<br/><br/>
</desc>
<term><code><label id="standards">&lt;standards&gt;</label></code>
</term>
<desc>
This element contains any number of standard elements which
specify what standards a particular piece of code does or does
not conform to.
<br/>
The defined values are -
<list>
<item><code>&lt;GNUstep/&gt;</code></item>
<item><code>&lt;OpenStep/&gt;</code></item>
<item><code>&lt;NotOpenStep/&gt;</code></item>
<item><code>&lt;MacOS-X/&gt;</code></item>
<item><code>&lt;NotMacOS-X/&gt;</code></item>
</list>
<br/>
</desc>
<term><code><label id="conform">&lt;conform&gt;</label></code></term>
<desc>
This element contains simple text giving the name of a protocol
@ -816,8 +795,7 @@
optional <ref id="vararg">vararg</ref> element),
followed by an optional <ref id="desc">desc</ref>,
zero or more <ref id="ivariable">ivariable</ref> elements,
zero or more <ref id="method">method</ref> elements,
and an optional <ref id="standards">standards</ref> element.
zero or more <ref id="method">method</ref> elements.
</p>
</desc>