Documentation generation improvments

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@29047 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-MacDonald 2009-11-23 09:42:18 +00:00
parent a3d9656e82
commit 19796a1465
6 changed files with 85 additions and 7 deletions

View file

@ -86,7 +86,12 @@
comment text is reformatted and then inserted into the output.<br />
Where multiple comments are associated with the same item, they are
joined together with a line break (&lt;br /&gt;) between each if
necessary.
necessary.<br />
Within a comment the special markup &lt;ignore&gt; and &lt;/ignore&gt;
may be used to tell autogsdoc to completely ignore the sourcecode
between these two pieces of markup (ie. the parser will skip from the
point just before it is told to start ignoring, to just after the point
where it is told to stop (or end of file if that occurs first).
</p>
<p>
The tool can easily be used to document programs as well as libraries,