Document Macro template.

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@14686 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
CaS 2002-10-09 10:47:26 +00:00
parent 4581584a64
commit 1941b1680b
2 changed files with 18 additions and 3 deletions

View file

@ -111,6 +111,7 @@ Base_AGSDOC_FLAGS = \
-Standards YES \ -Standards YES \
-ConstantsTemplate TypesAndConstants \ -ConstantsTemplate TypesAndConstants \
-FunctionsTemplate Functions \ -FunctionsTemplate Functions \
-MacrosTemplate Functions \
-TypedefsTemplate TypesAndConstants \ -TypedefsTemplate TypesAndConstants \
-VariablesTemplate TypesAndConstants \ -VariablesTemplate TypesAndConstants \
-WordMap '{\ -WordMap '{\

View file

@ -266,7 +266,7 @@
if the file does not exist. if the file does not exist.
<br />Insertion takes place immediately before the <em>back</em> <br />Insertion takes place immediately before the <em>back</em>
element (or if that does not exist, immediately before the end element (or if that does not exist, immediately before the end
of the <em>body</em> lement) in the template. of the <em>body</em> element) in the template.
</item> </item>
<item><strong>GenerateHtml</strong> <item><strong>GenerateHtml</strong>
May be used to specify if HTML output is to be generated. May be used to specify if HTML output is to be generated.
@ -304,6 +304,20 @@
If you wish to include such projects, you must do so explicitly If you wish to include such projects, you must do so explicitly
using <em>-Projects</em> using <em>-Projects</em>
</item> </item>
<item><strong>MacrosTemplate</strong>
Specify the name of a template document into which documentation
about macros should be inserted from all files in the project.<br />
This is useful if macro code is scattered around many
files, and you need to group it into one place.<br />
You are responsible for ensuring that the basic template document
(into which individual macro documentation is inserted) contains
all the other information you want, but as a convenience autogsdoc
will generate a simple template (which you may then edit) for you
if the file does not exist.
<br />Insertion takes place immediately before the <em>back</em>
element (or if that does not exist, immediately before the end
of the <em>body</em> element) in the template.
</item>
<item><strong>Project</strong> <item><strong>Project</strong>
May be used to specify the name of this project ... determines the May be used to specify the name of this project ... determines the
name of the index reference file produced as part of the documentation name of the index reference file produced as part of the documentation
@ -363,7 +377,7 @@
if the file does not exist. if the file does not exist.
<br />Insertion takes place immediately before the <em>back</em> <br />Insertion takes place immediately before the <em>back</em>
element (or if that does not exist, immediately before the end element (or if that does not exist, immediately before the end
of the <em>body</em> lement) in the template. of the <em>body</em> element) in the template.
</item> </item>
<item><strong>Up</strong> <item><strong>Up</strong>
A string used to supply the name to be used in the 'up' link from A string used to supply the name to be used in the 'up' link from
@ -384,7 +398,7 @@
if the file does not exist. if the file does not exist.
<br />Insertion takes place immediately before the <em>back</em> <br />Insertion takes place immediately before the <em>back</em>
element (or if that does not exist, immediately before the end element (or if that does not exist, immediately before the end
of the <em>body</em> lement) in the template. of the <em>body</em> element) in the template.
</item> </item>
<item><strong>Verbose</strong> <item><strong>Verbose</strong>
A boolean used to specify whether you want verbose debug/warning A boolean used to specify whether you want verbose debug/warning