mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-26 02:01:03 +00:00
Minor tidyup
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@8476 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
richard
parent
b323ba6b02
commit
d2ac6b1b5b
2 changed files with 106 additions and 52 deletions
|
|
@ -1,3 +1,7 @@
|
||||||
|
2001-01-04 Richard Frith-Macdonald <rfm@gnu.org>
|
||||||
|
|
||||||
|
* Tools/gsdoc.gsdoc: Tidied and fixed a few typos/spelling errors.
|
||||||
|
|
||||||
2001-01-04 Jonathan Gapen <jagapen@home.com>
|
2001-01-04 Jonathan Gapen <jagapen@home.com>
|
||||||
|
|
||||||
* configure.in, aclocal.m4, acconfig.h: Replace libxml detection with
|
* configure.in, aclocal.m4, acconfig.h: Replace libxml detection with
|
||||||
|
|
|
||||||
|
|
@ -575,58 +575,108 @@
|
||||||
Use of the tool is trivial - just provide it with a list of gsdoc
|
Use of the tool is trivial - just provide it with a list of gsdoc
|
||||||
file names, and it will produce a load of html output files.
|
file names, and it will produce a load of html output files.
|
||||||
</p>
|
</p>
|
||||||
<section>
|
<section>
|
||||||
<heading>Parameters</heading>
|
<heading>Parameters</heading>
|
||||||
<deflist>
|
<deflist>
|
||||||
<term><ref id="--makeRefs">--makeRefs=ReferencesFileName</ref></term>
|
<term><ref id="--makeRefs">--makeRefs=ReferencesFileName</ref> </term>
|
||||||
<desc>With this option, gsdoc reads gsdoc files and create ReferencesFileName.gsdocrefs files which can be used as <ref id="">--refs</ref> to make links between elements</desc>
|
<desc>
|
||||||
|
With this option, gsdoc reads gsdoc files and creates
|
||||||
<term><ref id="--projectName">--projectName=TheProjectName</ref></term>
|
ReferencesFileName.gsdocrefs files which can be used as
|
||||||
<desc>Set the project name to "TheProjectName".It is used fo index titles,...</desc>
|
<ref id="">--refs</ref> to make links between elements.
|
||||||
|
</desc>
|
||||||
<term><ref id="--refs">--refs=ARefFile or --refs=ARefDirectory</ref></term>
|
<term><ref id="--projectName">--projectName=TheProjectName</ref>
|
||||||
<desc>Use ARefFile.gsdocrefs (or files whith extensions .gsdocrefs in ARefDirectory directory) as references files. It's enable to make links bettwen documentations</desc>
|
</term>
|
||||||
|
<desc>
|
||||||
<term><ref id="--makeIndex">--makeIndex=MyIndexFileName</ref></term>
|
Set the project name to "TheProjectName". It is used to index
|
||||||
<desc>Create an index of the parsed files and save it as MyIndexName.gsdoc. You have to set --makeIndexTemplate option</desc>
|
titles,...
|
||||||
|
</desc>
|
||||||
<term><ref id="--makeIndexTemplate">--makeIndexTemplate=MyIndexTemplateFileName</ref></term>
|
<term><ref id="--refs">--refs=ARefFile or --refs=ARefDirectory</ref>
|
||||||
<desc>The file used as index template for makeIndex option</desc>
|
</term>
|
||||||
|
<desc>
|
||||||
<term><ref id="--define-">--define-XXX=YYY</ref></term>
|
Use ARefFile.gsdocrefs (or files with extensions .gsdocrefs in
|
||||||
<desc>Used to define a constant named XXX with value YYY in .gsdoc file, all [[infoDictionary.XXX]] texts are replaced with YYY</desc>
|
ARefDirectory directory) as references files. It enables you to
|
||||||
|
make links between documentation areas.
|
||||||
<term><ref id="-verbose">--verbose=X</ref></term>
|
</desc>
|
||||||
<desc>Level of traces from 0 to ...</desc>
|
<term><ref id="--makeIndex">--makeIndex=MyIndexFileName</ref></term>
|
||||||
|
<desc>
|
||||||
<term><ref id="--location">--location=file://usr/doc/gnustep/MyProject or --location=http://www.gnustep.org/gnustep/MyProject</ref></term>
|
Create an index of the parsed files and save it as
|
||||||
<desc>Location of the installed documentation (it helps to make kinks between projects)</desc>
|
MyIndexName.gsdoc. You have to set --makeIndexTemplate option.
|
||||||
|
</desc>
|
||||||
<term><ref id="files">file1 file2</ref></term>
|
<term><ref id="--makeIndexTemplate">--makeIndexTemplate=MyIndexTemplateFileName</ref></term>
|
||||||
<desc>.gsdoc files</desc>
|
<desc>
|
||||||
</deflist>
|
The file used as index template for makeIndex option
|
||||||
</section>
|
</desc>
|
||||||
<section>
|
<term><ref id="--define-">--define-XXX=YYY</ref></term>
|
||||||
<heading>Exemple</heading>
|
<desc>
|
||||||
<subsect>
|
Used to define a constant named XXX with value YYY in .gsdoc file,
|
||||||
<heading>AutoDoc</heading>
|
all [[infoDictionary.XXX]] texts are replaced with YYY
|
||||||
<example>
|
</desc>
|
||||||
autodoc -allclasses -format html -template /usr/GNUstep/System/Libraries/Resources/DocTemplates/AutoDocTemplate.gsdoc -copyright "Orange Concept" -define-author-name "Manuel Guesdon" -define-author-email "mguesdon@orange-concept.com" -define-author-desc "Developer" -define-author-url "http://www.orange-concept.com" -define-dtd-ref "/usr/GNUstep/System/Libraries/Resources/DTDs/gsdoc-0_6_6.dtd" -define-stylesheeturl "http://www.orange-concept.com/styles/default.css" -define-basetitle "MyDoc:" -define-dtd-url "http://www.gnustep.org/gsdoc-0_6_6.xml" -define-next "[[next]]" -define-prev "[[prev]]" -define-up "[[up]]" MySource.h
|
<term><ref id="-verbose">--verbose=X</ref></term>
|
||||||
</example>
|
<desc>
|
||||||
<p>
|
Level of traces from 0 to ...
|
||||||
The above example take MySource.h and MySource.m and generate one or more gsdoc files (they have the extension .html, so please rename them with .gsdoc extension after running AutoDoc
|
</desc>
|
||||||
</p>
|
<term><ref id="--location">--location=file://usr/doc/gnustep/MyProject or --location=http://www.gnustep.org/gnustep/MyProject</ref></term>
|
||||||
</subsect>
|
<desc>
|
||||||
<subsect>
|
Location of the installed documentation (it helps to make links
|
||||||
<heading>GSDoc</heading>
|
between projects)
|
||||||
<example>
|
</desc>
|
||||||
gsdoc MyFile1.gsdoc MyFile2.gsdoc Explanations.gsdoc --makeRefs --makeIndex --makeIndexTemplate=/usr/GNUstep/System/Libraries/Resources/DocTemplates/indextemplate.gsdoc --projectName="MyProject" --refs=/usr/doc/gnustep --define-version=2.1 --verbose=1 --location="/usr/doc/gnustep/MyProject"
|
<term><ref id="files">file1 file2</ref></term>
|
||||||
</example>
|
<desc>
|
||||||
<p>
|
The .gsdoc files to be processed.
|
||||||
The above example will parse MyFile1.gsdoc MyFile2.gsdoc and generate MyFile1.html and MyFile2.html. It generate MyProject.gsdocrefs which will countain references of symbols found in MyFile1.gsdoc and MyFile2.gsdoc. MyFile1.html and MyFile2.html will have links to symbols found in MyProject.gsdocrefs and in .gsdocrefs founds in subdirectories of /usr/doc/gnustep. I indicate that the location of this doc will be /usr/doc/gnustep/MyProject. It also generate an index of MyFile1.html and MyFile2.html contents with the template /usr/GNUstep/System/Libraries/Resources/DocTemplates/indextemplate.gsdoc. Index file is index.gsdoc and the resulting file index.html is automatically generated. I define "version" so the index will take this version.
|
</desc>
|
||||||
</p>
|
</deflist>
|
||||||
</subsect>
|
</section>
|
||||||
</section>
|
<section>
|
||||||
|
<heading>Example</heading>
|
||||||
|
<subsect>
|
||||||
|
<heading>AutoDoc</heading>
|
||||||
|
<example>
|
||||||
|
autodoc -allclasses -format html -template \
|
||||||
|
/usr/GNUstep/System/Libraries/Resources/DocTemplates/AutoDocTemplate.gsdoc \
|
||||||
|
-copyright "Orange Concept" \
|
||||||
|
-define-author-name "Manuel Guesdon" \
|
||||||
|
-define-author-email "mguesdon@orange-concept.com" \
|
||||||
|
-define-author-desc "Developer" \
|
||||||
|
-define-author-url "http://www.orange-concept.com" -define-dtd-ref \
|
||||||
|
"/usr/GNUstep/System/Libraries/Resources/DTDs/gsdoc-0_6_6.dtd" \
|
||||||
|
-define-stylesheeturl "http://www.orange-concept.com/styles/default.css" \
|
||||||
|
-define-basetitle "MyDoc:" \
|
||||||
|
-define-dtd-url "http://www.gnustep.org/gsdoc-0_6_6.xml" \
|
||||||
|
-define-next "[[next]]" -define-prev "[[prev]]" -define-up "[[up]]" \
|
||||||
|
MySource.h
|
||||||
|
</example>
|
||||||
|
<p>
|
||||||
|
The above example takes MySource.h and MySource.m and generates
|
||||||
|
one or more gsdoc files (they have the extension .html,
|
||||||
|
so please rename them with .gsdoc extension after running
|
||||||
|
AutoDoc
|
||||||
|
</p>
|
||||||
|
</subsect>
|
||||||
|
<subsect>
|
||||||
|
<heading>GSDoc</heading>
|
||||||
|
<example>
|
||||||
|
gsdoc MyFile1.gsdoc MyFile2.gsdoc Explanations.gsdoc --makeRefs --makeIndex \
|
||||||
|
--makeIndexTemplate=/usr/GNUstep/System/Libraries/Resources/DocTemplates/indextemplate.gsdoc \
|
||||||
|
--projectName="MyProject" --refs=/usr/doc/gnustep --define-version=2.1 \
|
||||||
|
--verbose=1 --location="/usr/doc/gnustep/MyProject"
|
||||||
|
</example>
|
||||||
|
<p>
|
||||||
|
The above example will parse MyFile1.gsdoc MyFile2.gsdoc and
|
||||||
|
generate MyFile1.html and MyFile2.html. It generates
|
||||||
|
MyProject.gsdocrefs which will countain references of symbols
|
||||||
|
found in MyFile1.gsdoc and MyFile2.gsdoc. MyFile1.html and
|
||||||
|
MyFile2.html will have links to symbols found in
|
||||||
|
MyProject.gsdocrefs and in .gsdocrefs founds in subdirectories of
|
||||||
|
/usr/doc/gnustep. I indicate that the location of this doc will
|
||||||
|
be /usr/doc/gnustep/MyProject. It also generate an index of
|
||||||
|
MyFile1.html and MyFile2.html contents with the template
|
||||||
|
/usr/GNUstep/System/Libraries/Resources/DocTemplates/indextemplate.gsdoc.
|
||||||
|
Index file is index.gsdoc and the resulting file index.html is
|
||||||
|
automatically generated. I define "version" so the index will
|
||||||
|
take this version.
|
||||||
|
</p>
|
||||||
|
</subsect>
|
||||||
|
</section>
|
||||||
</chapter>
|
</chapter>
|
||||||
|
|
||||||
<back>
|
<back>
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue