mirror of
https://github.com/gnustep/libs-base.git
synced 2025-05-30 16:30:41 +00:00
Some documentation improvements
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@6748 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-MacDonald
parent
e0fe6dddf7
commit
7fb5abafdb
8 changed files with 1045 additions and 120 deletions
|
|
@ -32,7 +32,7 @@ include ../config.mak
|
|||
|
||||
# DTDs to install
|
||||
dtddir = $(GNUSTEP_RESOURCES)/DTDs
|
||||
DTD_FILES = gsdoc-0_6_5.dtd
|
||||
DTD_FILES = gsdoc-0_6_5.dtd gsdoc-0_6_6.dtd
|
||||
|
||||
# The application to be compiled
|
||||
TOOL_NAME = gdnc gsdoc defaults plmerge \
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@
|
|||
# after-all::
|
||||
|
||||
# Things to do before installing
|
||||
# before-install::
|
||||
before-install:: documentation
|
||||
|
||||
# Things to do after installing
|
||||
after-install::
|
||||
|
|
@ -78,3 +78,6 @@ copy-dist: $(DIST_FILES)
|
|||
cp $$f ../snap/Tools ; \
|
||||
done
|
||||
|
||||
documentation: $(GNUSTEP_OBJ_DIR)/gsdoc
|
||||
$(GNUSTEP_OBJ_DIR)/gsdoc gsdoc
|
||||
|
||||
|
|
|
|||
447
Tools/gsdoc-0_6_6.dtd
Normal file
447
Tools/gsdoc-0_6_6.dtd
Normal file
|
|
@ -0,0 +1,447 @@
|
|||
<!--
|
||||
|
||||
XML Document Type Definition for GNUstep Documentation Markup
|
||||
Language (gsdoc).
|
||||
|
||||
Written by Richard Frith-Macdonald
|
||||
Based on GDML by 1997 Yoo C. Chung
|
||||
|
||||
This is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU General Public License
|
||||
as published by the Free Software Foundation; either
|
||||
version 2 of the License, or (at your option) any later
|
||||
version.
|
||||
|
||||
This document is distributed in the hope that it will be
|
||||
useful, but WITHOUT ANY WARRANTY; without even the implied
|
||||
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
||||
PURPOSE. See the GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General
|
||||
Public License along with this software; if not, write to the
|
||||
Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA
|
||||
02139, USA.
|
||||
|
||||
-->
|
||||
|
||||
|
||||
<!--
|
||||
gsdoc is an XML language - Typical usage:
|
||||
<?xml version="1.0"?>
|
||||
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.6//EN"
|
||||
"http://www.gnustep.org/gsdoc.xml">
|
||||
<gsdoc base="myDocName">
|
||||
</gsdoc>
|
||||
-->
|
||||
|
||||
|
||||
<!--***** Character entities. *****-->
|
||||
|
||||
<!-- General purpose characters for gsdoc. -->
|
||||
<!ENTITY copy "&copy;"> <!-- copyright symbol -->
|
||||
<!ENTITY tm "&trade;"> <!-- trademark symbol -->
|
||||
<!ENTITY dots "&dots;"> <!-- ellipsis (...) -->
|
||||
<!ENTITY nbsp "&nbsp;"> <!-- non breakable space -->
|
||||
<!ENTITY amp "&#38;"> <!-- ampersand -->
|
||||
<!ENTITY apos "'"> <!-- apos -->
|
||||
<!ENTITY quot """> <!-- quotation mark (") -->
|
||||
<!ENTITY lt "&#60;"> <!-- lesser than symbol -->
|
||||
<!ENTITY gt ">"> <!-- greater than symbol -->
|
||||
|
||||
<!--***** Entity declarations. *****-->
|
||||
|
||||
<!-- Boolean values for attributes -->
|
||||
<!ENTITY % boolean "(yes|no)">
|
||||
|
||||
<!-- Entity for phrase elements. -->
|
||||
<!ENTITY % phrase "var | em | code | strong | file | site">
|
||||
|
||||
<!-- Entity for cross references. -->
|
||||
<!ENTITY % xref "ref | uref | url | email">
|
||||
|
||||
<!-- Entity for anchors. -->
|
||||
<!ENTITY % anchor "label | entry">
|
||||
|
||||
<!-- Entity for text level elements. -->
|
||||
<!ENTITY % text "#PCDATA | %xref; | %anchor; | %phrase; | footnote | br">
|
||||
|
||||
<!-- Entity for definition elements. -->
|
||||
<!ENTITY % def "class|jclass|category|protocol|function|macro|type|variable">
|
||||
|
||||
<!-- Entity for list elements. -->
|
||||
<!ENTITY % list "list | enum | deflist | qalist">
|
||||
|
||||
<!-- Entity for block elements like paragraphs. -->
|
||||
<!ENTITY % block "%def; | %list; | p | example | embed">
|
||||
|
||||
<!--**********-->
|
||||
|
||||
|
||||
<!-- Used for describing something. -->
|
||||
<!ELEMENT desc (%text; | %list; | p | example | embed)*>
|
||||
|
||||
<!-- A footnote. -->
|
||||
<!ELEMENT footnote (%text;)*>
|
||||
|
||||
|
||||
<!--***** Phrase elements. *****-->
|
||||
|
||||
<!-- The content is a metasyntactic variable name. -->
|
||||
<!ELEMENT var (%text;)*>
|
||||
|
||||
<!-- Emphasize the content. -->
|
||||
<!ELEMENT em (%text;)*>
|
||||
|
||||
<!-- The content is too important that simple emphasizing isn't
|
||||
enough. -->
|
||||
<!ELEMENT strong (%text;)*>
|
||||
|
||||
<!-- The content is either a name for code (e.g. class names), or a
|
||||
relatively short code fragment. -->
|
||||
<!ELEMENT code (%text;)*>
|
||||
|
||||
<!-- The content is a file name. -->
|
||||
<!ELEMENT file (#PCDATA)*>
|
||||
|
||||
<!-- The content is a fully qualified domain name on the Internet. -->
|
||||
<!ELEMENT site (#PCDATA)*>
|
||||
|
||||
<!--***** List elements. *****-->
|
||||
|
||||
<!-- An item in a list. -->
|
||||
<!ELEMENT item (%text; | %block;)*>
|
||||
|
||||
<!-- An enumerated list. -->
|
||||
<!ELEMENT enum (item+)>
|
||||
|
||||
<!-- A ordinary, unnumbered list. -->
|
||||
<!ELEMENT list (item+)>
|
||||
|
||||
<!-- A term to defined in a definition list. -->
|
||||
<!ELEMENT term (%text;)*>
|
||||
|
||||
<!-- A definition list. -->
|
||||
<!ELEMENT deflist (term, desc)+>
|
||||
|
||||
<!-- A question for a question and answer list. -->
|
||||
<!ELEMENT question (%text;)*>
|
||||
|
||||
<!-- An answer for a question and answer list. -->
|
||||
<!ELEMENT answer (%block;)*>
|
||||
|
||||
<!-- A question and answer list. -->
|
||||
<!ELEMENT qalist (question, answer)+>
|
||||
|
||||
<!--**********-->
|
||||
|
||||
|
||||
<!--***** Cross references. *****-->
|
||||
|
||||
<!-- A reference.
|
||||
ID of the reference.
|
||||
TYPE of reference, if implied, a reference to a label.
|
||||
CLASS specific class for a method
|
||||
-->
|
||||
<!ELEMENT ref (%text;)*>
|
||||
<!ATTLIST ref
|
||||
id CDATA #REQUIRED
|
||||
type (class|protocol|method|function|type|macro|variable|label) "label"
|
||||
class CDATA #IMPLIED
|
||||
>
|
||||
|
||||
<!-- An e-mail address. -->
|
||||
<!ELEMENT email (%text;)*>
|
||||
<!ATTLIST email
|
||||
address CDATA #IMPLIED
|
||||
>
|
||||
|
||||
<!-- A URL. -->
|
||||
<!ELEMENT url EMPTY>
|
||||
<!ATTLIST url
|
||||
url CDATA #IMPLIED
|
||||
>
|
||||
|
||||
<!-- A reference to a URL.
|
||||
The text contained appears in the output.
|
||||
-->
|
||||
<!ELEMENT uref (%text;)*>
|
||||
<!ATTLIST uref
|
||||
url CDATA #REQUIRED
|
||||
>
|
||||
|
||||
|
||||
<!--***** Anchors. *****-->
|
||||
|
||||
<!-- An anchor for a general reference.
|
||||
The text contained appears in the ouput.
|
||||
-->
|
||||
<!ELEMENT label (%text;)*>
|
||||
<!ATTLIST label
|
||||
id CDATA #REQUIRED
|
||||
>
|
||||
|
||||
<!-- An entry for the general index.
|
||||
The text that is contained appears in the index, and never in
|
||||
the text itself.
|
||||
-->
|
||||
<!ELEMENT entry (%text;)*>
|
||||
<!ATTLIST entry
|
||||
id CDATA #REQUIRED
|
||||
>
|
||||
|
||||
<!-- Entity for standard elements. -->
|
||||
<!ELEMENT GNUstep EMPTY>
|
||||
<!ELEMENT OpenStep EMPTY>
|
||||
<!ELEMENT NotOpenStep EMPTY>
|
||||
<!ELEMENT MacOS-X EMPTY>
|
||||
<!ELEMENT NotMacOS-X EMPTY>
|
||||
|
||||
<!-- A standard that something is or isn't compliant with. -->
|
||||
<!ENTITY % standard "GNUstep | OpenStep | NotOpenStep | MacOS-X | NotMacOS-X">
|
||||
|
||||
<!ELEMENT standards (%standard;)*>
|
||||
|
||||
<!--***** Argument elements. *****-->
|
||||
|
||||
<!-- An argument. -->
|
||||
<!ELEMENT arg (#PCDATA)*>
|
||||
<!ATTLIST arg
|
||||
type CDATA #IMPLIED
|
||||
>
|
||||
|
||||
<!-- Denotes that the rest of the arguments is a variable list,
|
||||
like in printf().
|
||||
-->
|
||||
<!ELEMENT vararg EMPTY>
|
||||
|
||||
|
||||
<!--***** Method elements. *****-->
|
||||
|
||||
<!-- A component for a method selector. -->
|
||||
<!ELEMENT sel (#PCDATA)*>
|
||||
|
||||
<!-- A method. If there is no DESC, it is understood that the element
|
||||
is used to override some information from the same method in the
|
||||
superclass.
|
||||
If factory not set, instance method
|
||||
-->
|
||||
<!ELEMENT method (((sel, arg?), (sel, arg)*, vararg?), desc?, standards?)>
|
||||
<!ATTLIST method
|
||||
type CDATA #IMPLIED
|
||||
factory %boolean; "no"
|
||||
init %boolean; "no"
|
||||
override (subclass|never) #IMPLIED
|
||||
>
|
||||
|
||||
<!-- A java method definition. -->
|
||||
<!ELEMENT jmethod ((arg*, vararg?), declared?, desc?, standards?)>
|
||||
<!ATTLIST jmethod
|
||||
name CDATA #REQUIRED
|
||||
type CDATA #IMPLIED
|
||||
factory %boolean; "no"
|
||||
init %boolean; "no"
|
||||
override (subclass|never) #IMPLIED
|
||||
>
|
||||
|
||||
<!--***** Elements for definitions of classes, functions, etc. *****-->
|
||||
|
||||
<!-- Show what header file something lives in. -->
|
||||
<!ELEMENT declared (#PCDATA)*>
|
||||
|
||||
<!-- A macro definition. -->
|
||||
<!ELEMENT macro ((arg*, vararg?), declared?, desc?, standards?)>
|
||||
<!ATTLIST macro
|
||||
id CDATA #IMPLIED
|
||||
name CDATA #REQUIRED
|
||||
>
|
||||
|
||||
<!ELEMENT typespec (#PCDATA)*>
|
||||
|
||||
<!-- A type definition. -->
|
||||
<!ELEMENT type (typespec, declared?, desc?, standards?)>
|
||||
<!ATTLIST type
|
||||
id CDATA #IMPLIED
|
||||
name CDATA #REQUIRED
|
||||
>
|
||||
|
||||
<!-- Variable definition.
|
||||
VALUE may be set for a constant or a default value
|
||||
-->
|
||||
<!ELEMENT variable (declared?, desc?, standards?)>
|
||||
<!ATTLIST variable
|
||||
id CDATA #IMPLIED
|
||||
name CDATA #REQUIRED
|
||||
type CDATA #REQUIRED
|
||||
value CDATA #IMPLIED
|
||||
role (except|defaults|notify|key) #IMPLIED
|
||||
>
|
||||
|
||||
<!-- A function definition. -->
|
||||
<!ELEMENT function ((arg*, vararg?), declared?, desc?, standards?)>
|
||||
<!ATTLIST function
|
||||
id CDATA #IMPLIED
|
||||
name CDATA #REQUIRED
|
||||
type CDATA #REQUIRED
|
||||
>
|
||||
|
||||
<!-- Protocol definition. -->
|
||||
<!ELEMENT protocol (declared?, desc?, method*, standards?)>
|
||||
<!ATTLIST protocol
|
||||
id CDATA #IMPLIED
|
||||
name CDATA #REQUIRED
|
||||
>
|
||||
|
||||
<!-- Category definition. -->
|
||||
<!ELEMENT category (declared?, desc?, method*, standards?)>
|
||||
<!ATTLIST category
|
||||
id CDATA #IMPLIED
|
||||
name CDATA #REQUIRED
|
||||
class CDATA #REQUIRED
|
||||
>
|
||||
|
||||
<!-- Show a protocol a class conforms to. -->
|
||||
<!ELEMENT conform (#PCDATA)*>
|
||||
|
||||
<!ELEMENT class (declared?, conform*, desc?, method*, standards?)>
|
||||
<!ATTLIST class
|
||||
id CDATA #IMPLIED
|
||||
name CDATA #REQUIRED
|
||||
super CDATA #IMPLIED
|
||||
>
|
||||
|
||||
<!ELEMENT jclass (declared?, conform*, desc?, jmethod*, standards?)>
|
||||
<!ATTLIST jclass
|
||||
id CDATA #IMPLIED
|
||||
name CDATA #REQUIRED
|
||||
super CDATA #IMPLIED
|
||||
>
|
||||
|
||||
|
||||
<!--***** Elements for ordinary block level elements. *****-->
|
||||
|
||||
<!-- A line break. -->
|
||||
<!ELEMENT br EMPTY>
|
||||
|
||||
<!-- A paragraph. -->
|
||||
<!ELEMENT p (%text;)*>
|
||||
|
||||
<!-- An example. -->
|
||||
<!ELEMENT example (#PCDATA)*>
|
||||
<!ATTLIST example
|
||||
id CDATA #IMPLIED
|
||||
caption CDATA #IMPLIED
|
||||
>
|
||||
|
||||
<!-- An embedded object. If it is of a type that the SGML processor
|
||||
cannot handle, then use the content, which is ignored otherwise.
|
||||
refer - method of referring to object (default is file)
|
||||
src - the reference to the object
|
||||
type - Internet media type of the objec
|
||||
title - optional title describing object
|
||||
-->
|
||||
<!ELEMENT embed (%block;)*>
|
||||
<!ATTLIST embed
|
||||
id CDATA #IMPLIED
|
||||
refer (file|url) #IMPLIED
|
||||
src CDATA #REQUIRED
|
||||
type CDATA #IMPLIED
|
||||
title CDATA #IMPLIED
|
||||
>
|
||||
|
||||
<!--***** Elements for document structure such as chapters. *****-->
|
||||
|
||||
<!-- A heading for chapters, sections, ... -->
|
||||
<!ELEMENT heading (%text;)*>
|
||||
|
||||
<!-- A subsubsection. -->
|
||||
<!ELEMENT subsubsect (heading, (%block;)*)>
|
||||
<!ATTLIST subsubsect
|
||||
id CDATA #IMPLIED
|
||||
>
|
||||
|
||||
<!-- A subsection. -->
|
||||
<!ELEMENT subsect (heading, (%block;)*, subsubsect*)>
|
||||
<!ATTLIST subsect
|
||||
id CDATA #IMPLIED
|
||||
>
|
||||
|
||||
<!-- A section. -->
|
||||
<!ELEMENT section (heading, (%block;)*, subsect*)>
|
||||
<!ATTLIST section
|
||||
id CDATA #IMPLIED
|
||||
>
|
||||
|
||||
<!-- A chapter. -->
|
||||
<!ELEMENT chapter (heading, (%block;)*, section*)>
|
||||
<!ATTLIST chapter
|
||||
id CDATA #IMPLIED
|
||||
>
|
||||
|
||||
|
||||
<!--***** Elements that make searching for things easier. *****-->
|
||||
|
||||
<!-- Table of contents. -->
|
||||
<!ELEMENT contents EMPTY>
|
||||
|
||||
<!-- Index -->
|
||||
<!ELEMENT index EMPTY>
|
||||
<!ATTLIST index
|
||||
type (class|protocol|method|function|type|macro|variable|label) "label"
|
||||
>
|
||||
|
||||
|
||||
<!--***** Elements that describe the document itself. *****-->
|
||||
|
||||
<!-- Copyright of the document. -->
|
||||
<!ELEMENT copy (%text;)*>
|
||||
|
||||
<!-- An abstract. -->
|
||||
<!ELEMENT abstract (%text;)*>
|
||||
|
||||
<!-- The version of the document. -->
|
||||
<!ELEMENT version (%text;)*>
|
||||
|
||||
<!-- The date the document was written. -->
|
||||
<!ELEMENT date (%text;)*>
|
||||
|
||||
<!-- An author. -->
|
||||
<!ELEMENT author (email?, url?, desc?)>
|
||||
<!ATTLIST author
|
||||
name CDATA #REQUIRED
|
||||
>
|
||||
|
||||
<!-- The title of the document. -->
|
||||
<!ELEMENT title (%text;)*>
|
||||
|
||||
|
||||
<!--***** The topmost structures for the document body. *****-->
|
||||
|
||||
<!-- Unnumbered parts appearing in the front, such as a preface. -->
|
||||
<!ELEMENT front (contents?, chapter*)>
|
||||
|
||||
<!-- Unnumbered parts appearing in the back, such as an afterword or
|
||||
indices.
|
||||
-->
|
||||
<!ELEMENT back (chapter*, index?)>
|
||||
|
||||
|
||||
<!--***** The topmost structures for the document. *****-->
|
||||
|
||||
<!-- The head containing general information about the document. -->
|
||||
<!ELEMENT head (title, author+, version?, date?, abstract?, copy?)>
|
||||
|
||||
<!-- The main part of the document. -->
|
||||
<!ELEMENT body (front?, chapter+, back?)>
|
||||
|
||||
<!--**********-->
|
||||
|
||||
|
||||
<!-- The entire document. -->
|
||||
<!ELEMENT gsdoc (head, body)>
|
||||
<!ATTLIST gsdoc
|
||||
base CDATA #IMPLIED
|
||||
next CDATA #IMPLIED
|
||||
prev CDATA #IMPLIED
|
||||
up CDATA #IMPLIED
|
||||
>
|
||||
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0"?>
|
||||
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.5//EN" "http://www.gnustep.org/gsdoc-0_6_5.xml">
|
||||
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.6//EN" "http://www.gnustep.org/gsdoc-0_6_6.xml">
|
||||
<gsdoc base="gsdoc">
|
||||
<head>
|
||||
<title>GNUstep Documentation XML markup language (GSDoc)</title>
|
||||
|
|
@ -10,8 +10,8 @@
|
|||
A person who has devotes far too much time to GNUstep development.
|
||||
</desc>
|
||||
</author>
|
||||
<version>0.1</version>
|
||||
<date>4 march, 2000</date>
|
||||
<version>0.2</version>
|
||||
<date>21 June, 2000</date>
|
||||
<abstract>
|
||||
This documents the GNUstep Documentation markup language and tools
|
||||
</abstract>
|
||||
|
|
@ -118,8 +118,8 @@
|
|||
</p>
|
||||
<example>
|
||||
<?xml version="1.0"?>
|
||||
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.5//EN" "http://www.gnustep.org/gsdoc-0_6_5.xml">
|
||||
<gsdoc base="MyDoc" prev="First.html" next="Last.html" up="Overview.html">
|
||||
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.6//EN" "http://www.gnustep.org/gsdoc-0_6_6.xml">
|
||||
<gsdoc base="MyDoc" prev="First" next="Last" up="Overview">
|
||||
<head>
|
||||
... your document head here
|
||||
</head>
|
||||
|
|
@ -184,22 +184,22 @@
|
|||
document head that must be present.
|
||||
</p>
|
||||
<example>
|
||||
<head>
|
||||
<title>GNUstep Documentation XML markup language (GSDoc)</title>
|
||||
<author name="Richard Frith-Macdonald">
|
||||
<email address="rfm@gnu.org"/>
|
||||
<url url="http://www.gnustep.org/developers/whoiswho.html"/>
|
||||
<desc>
|
||||
A person who has devotes far too much time to GNUstep development.
|
||||
</desc>
|
||||
</author>
|
||||
<version>0.1</version>
|
||||
<date>4 march, 2000</date>
|
||||
<abstract>
|
||||
This documents the GNUstep Documentation markup language and tools
|
||||
</abstract>
|
||||
<copy>Free Software Foundation, Inc.</copy>
|
||||
</head>
|
||||
<head>
|
||||
<title>GNUstep Documentation XML markup language (GSDoc)</title>
|
||||
<author name="Richard Frith-Macdonald">
|
||||
<email address="rfm@gnu.org"/>
|
||||
<url url="http://www.gnustep.org/developers/whoiswho.html"/>
|
||||
<desc>
|
||||
A person who has devotes far too much time to GNUstep development.
|
||||
</desc>
|
||||
</author>
|
||||
<version>0.1</version>
|
||||
<date>4 march, 2000</date>
|
||||
<abstract>
|
||||
This documents the GNUstep Documentation markup language and tools
|
||||
</abstract>
|
||||
<copy>Free Software Foundation, Inc.</copy>
|
||||
</head>
|
||||
</example>
|
||||
<p>
|
||||
The above example shows all the elements possible in a document head -
|
||||
|
|
@ -250,6 +250,63 @@
|
|||
parts of the document would be expected to have their own separate
|
||||
page numbering schemes.
|
||||
</p>
|
||||
<example>
|
||||
<body>
|
||||
<front>
|
||||
<contents/>
|
||||
<chapter>
|
||||
<heading>Preface</heading>
|
||||
<p>
|
||||
Here is an introductory chapter for a dummy document.
|
||||
</p>
|
||||
</chapter>
|
||||
</front>
|
||||
<chapter>
|
||||
<heading>Main text</heading>
|
||||
<p>
|
||||
Here is the main text of a chapter in the document.
|
||||
</p>
|
||||
</chapter>
|
||||
<back>
|
||||
<chapter>
|
||||
<heading>Afterword</heading>
|
||||
<p>
|
||||
Adn after the main part of the doucment we can have some other stuff.
|
||||
</p>
|
||||
</chapter>
|
||||
<index type="class"/>
|
||||
</back>
|
||||
</body>
|
||||
</example>
|
||||
<p>
|
||||
The above example shows all the elements possible in a document body -
|
||||
</p>
|
||||
<deflist>
|
||||
<term><label id="title">front</label></term>
|
||||
<desc>
|
||||
This is an optional part of the document that can come before the
|
||||
main text. Typically, this could be used to contain an automatically
|
||||
generated contents page and possibly an introduction.
|
||||
When output is generated in book form, this part of the document
|
||||
would probably have a different page numbering scheme from the
|
||||
main part.
|
||||
</desc>
|
||||
<term><label id="chapter">chapter</label></term>
|
||||
<desc>
|
||||
<p>
|
||||
After the <em>front</em> part of the document body comes a
|
||||
mandatory sequence of one or more chapters. This is where
|
||||
the main part of the document resides.
|
||||
</p>
|
||||
</desc>
|
||||
<term><label id="back">back</label></term>
|
||||
<desc>
|
||||
After the chapters making up the main part of the body of the
|
||||
document is an optional <em>back</em> part which may contain
|
||||
chapters (such as appendices) possibly followed by an automatically
|
||||
generated index.
|
||||
</desc>
|
||||
</deflist>
|
||||
</section>
|
||||
</chapter>
|
||||
|
||||
|
|
|
|||
186
Tools/gsdoc.m
186
Tools/gsdoc.m
|
|
@ -505,6 +505,7 @@ loader(const char *url, const char* eid, xmlParserCtxtPtr *ctxt)
|
|||
}
|
||||
|
||||
if (strcmp(node->name, "class") == 0
|
||||
|| strcmp(node->name, "jclass") == 0
|
||||
|| strcmp(node->name, "category") == 0
|
||||
|| strcmp(node->name, "protocol") == 0
|
||||
|| strcmp(node->name, "function") == 0
|
||||
|
|
@ -772,7 +773,8 @@ loader(const char *url, const char* eid, xmlParserCtxtPtr *ctxt)
|
|||
{
|
||||
NSMutableString *text = [NSMutableString string];
|
||||
|
||||
if (strcmp(node->name, "class") == 0)
|
||||
if ((strcmp(node->name, "class") == 0)
|
||||
|| (strcmp(node->name, "jclass") == 0))
|
||||
{
|
||||
NSString *className = [self getProp: "name" fromNode: node];
|
||||
NSString *superName = [self getProp: "super" fromNode: node];
|
||||
|
|
@ -819,7 +821,8 @@ loader(const char *url, const char* eid, xmlParserCtxtPtr *ctxt)
|
|||
desc = [self parseDesc: node];
|
||||
node = node->next;
|
||||
}
|
||||
while (node != 0 && strcmp(node->name, "method") == 0)
|
||||
while (node != 0 && ((strcmp(node->name, "method") == 0)
|
||||
|| (strcmp(node->name, "jmethod") == 0)))
|
||||
{
|
||||
NSString *s = [self parseMethod: node];
|
||||
|
||||
|
|
@ -1315,7 +1318,15 @@ loader(const char *url, const char* eid, xmlParserCtxtPtr *ctxt)
|
|||
}
|
||||
else
|
||||
{
|
||||
xmlNodePtr old = node;
|
||||
|
||||
[text appendString: [self parseText: node end: &node]];
|
||||
/*
|
||||
* If we found text, the node will have been advanced, but if
|
||||
* it failed we need to advance ourselves.
|
||||
*/
|
||||
if (node == old)
|
||||
node = node->next;
|
||||
continue;
|
||||
}
|
||||
|
||||
|
|
@ -1502,11 +1513,26 @@ loader(const char *url, const char* eid, xmlParserCtxtPtr *ctxt)
|
|||
[text appendString: @"</head>\r\n"];
|
||||
[text appendString: @"<body>\r\n"];
|
||||
if (prevName != nil)
|
||||
[text appendFormat: @"<a href=\"%@\">[Previous]</a>\n", prevName];
|
||||
{
|
||||
if ([[prevName pathExtension] isEqual: @"html"] == YES)
|
||||
[text appendFormat: @"<a href=\"%@\">[Previous]</a>\n", prevName];
|
||||
else
|
||||
[text appendFormat: @"<a href=\"%@.html\">[Previous]</a>\n", prevName];
|
||||
}
|
||||
if (upName != nil)
|
||||
[text appendFormat: @"<a href=\"%@\">[Up]</a>\n", upName];
|
||||
{
|
||||
if ([[upName pathExtension] isEqual: @"html"] == YES)
|
||||
[text appendFormat: @"<a href=\"%@\">[Up]</a>\n", upName];
|
||||
else
|
||||
[text appendFormat: @"<a href=\"%@.html\">[Up]</a>\n", upName];
|
||||
}
|
||||
if (nextName != nil)
|
||||
[text appendFormat: @"<a href=\"%@\">[Next]</a>\n", nextName];
|
||||
{
|
||||
if ([[nextName pathExtension] isEqual: @"html"] == YES)
|
||||
[text appendFormat: @"<a href=\"%@\">[Next]</a>\n", nextName];
|
||||
else
|
||||
[text appendFormat: @"<a href=\"%@.html\">[Next]</a>\n", nextName];
|
||||
}
|
||||
|
||||
[text appendFormat: @"<h1>%@</h1>\r\n", title];
|
||||
|
||||
|
|
@ -1783,11 +1809,11 @@ loader(const char *url, const char* eid, xmlParserCtxtPtr *ctxt)
|
|||
NSString *ref = [self getProp: "id" fromNode: node];
|
||||
NSString *type = [self getProp: "type" fromNode: node];
|
||||
NSString *over = [self getProp: "override" fromNode: node];
|
||||
// NSString *role = [self getProp: "role" fromNode: node];
|
||||
BOOL factory = [[self getProp: "factory" fromNode: node] boolValue];
|
||||
BOOL desInit = [[self getProp: "init" fromNode: node] boolValue];
|
||||
NSMutableString *lText = [NSMutableString string];
|
||||
NSMutableString *sText = [NSMutableString string];
|
||||
BOOL isJava = (strcmp(node->name, "jmethod") == 0);
|
||||
NSString *desc = nil;
|
||||
NSArray *standards = nil;
|
||||
|
||||
|
|
@ -1796,56 +1822,117 @@ loader(const char *url, const char* eid, xmlParserCtxtPtr *ctxt)
|
|||
ref = [NSString stringWithFormat: @"method-%u",
|
||||
labelIndex++];
|
||||
}
|
||||
if (factory)
|
||||
if (isJava)
|
||||
{
|
||||
[lText appendString: @"+ ("];
|
||||
}
|
||||
else
|
||||
{
|
||||
[lText appendString: @"- ("];
|
||||
}
|
||||
if (type == nil)
|
||||
type = @"id";
|
||||
[lText appendString: type];
|
||||
[lText appendString: @")"];
|
||||
NSMutableString *decl = [NSMutableString string];
|
||||
NSMutableString *args = [NSMutableString stringWithString: @"("];
|
||||
NSString *name = [self getProp: "name" fromNode: node];
|
||||
|
||||
node = node->children;
|
||||
while (node != 0 && strcmp(node->name, "sel") == 0)
|
||||
{
|
||||
NSString *sel = [self parseText: node->children];
|
||||
if (factory)
|
||||
{
|
||||
[decl appendString: @"static "];
|
||||
}
|
||||
if (type == nil)
|
||||
type = @"Object";
|
||||
[decl appendString: type];
|
||||
[decl appendString: @" "];
|
||||
|
||||
if (sel == nil) return nil;
|
||||
[sText appendString: sel];
|
||||
[lText appendFormat: @" <b>%@</b>", sel];
|
||||
node = node->next;
|
||||
if (node != 0 && strcmp(node->name, "arg") == 0)
|
||||
node = node->children;
|
||||
while (node != 0 && strcmp(node->name, "arg") == 0)
|
||||
{
|
||||
NSString *arg = [self parseText: node->children];
|
||||
NSString *typ = [self getProp: "type" fromNode: node];
|
||||
|
||||
if (arg == nil) return nil;
|
||||
if (arg == nil) break;
|
||||
if ([args length] > 1)
|
||||
{
|
||||
[args appendString: @", "];
|
||||
}
|
||||
if (typ != nil)
|
||||
{
|
||||
[lText appendFormat: @" (%@)%@", typ, arg];
|
||||
[args appendString: typ];
|
||||
[args appendString: @" "];
|
||||
}
|
||||
[args appendString: arg];
|
||||
node = node->next;
|
||||
}
|
||||
if (node != 0 && strcmp(node->name, "vararg") == 0)
|
||||
{
|
||||
if ([args length] > 1)
|
||||
{
|
||||
[args appendString: @", ..."];
|
||||
}
|
||||
else
|
||||
{
|
||||
[lText appendString: @" "];
|
||||
[lText appendString: arg];
|
||||
[args appendString: @"..."];
|
||||
}
|
||||
node = node->next;
|
||||
if (node != 0 && strcmp(node->name, "vararg") == 0)
|
||||
{
|
||||
[lText appendString: @", ..."];
|
||||
node = node->next;
|
||||
break;
|
||||
}
|
||||
}
|
||||
[args appendString: @")"];
|
||||
|
||||
[lText appendString: decl];
|
||||
[lText appendString: @"<b>"];
|
||||
[lText appendString: name];
|
||||
[lText appendString: @"</b>"];
|
||||
[lText appendString: args];
|
||||
[sText appendString: decl];
|
||||
[sText appendString: name];
|
||||
[sText appendString: args];
|
||||
}
|
||||
else
|
||||
{
|
||||
if (factory)
|
||||
{
|
||||
[lText appendString: @"+ ("];
|
||||
}
|
||||
else
|
||||
{
|
||||
break; /* Just a selector */
|
||||
[lText appendString: @"- ("];
|
||||
}
|
||||
if (type == nil)
|
||||
type = @"id";
|
||||
[lText appendString: type];
|
||||
[lText appendString: @")"];
|
||||
|
||||
node = node->children;
|
||||
while (node != 0 && strcmp(node->name, "sel") == 0)
|
||||
{
|
||||
NSString *sel = [self parseText: node->children];
|
||||
|
||||
if (sel == nil) return nil;
|
||||
[sText appendString: sel];
|
||||
[lText appendFormat: @" <b>%@</b>", sel];
|
||||
node = node->next;
|
||||
if (node != 0 && strcmp(node->name, "arg") == 0)
|
||||
{
|
||||
NSString *arg = [self parseText: node->children];
|
||||
NSString *typ = [self getProp: "type" fromNode: node];
|
||||
|
||||
if (arg == nil) return nil;
|
||||
if (typ != nil)
|
||||
{
|
||||
[lText appendFormat: @" (%@)%@", typ, arg];
|
||||
}
|
||||
else
|
||||
{
|
||||
[lText appendString: @" "];
|
||||
[lText appendString: arg];
|
||||
}
|
||||
node = node->next;
|
||||
if (node != 0 && strcmp(node->name, "vararg") == 0)
|
||||
{
|
||||
[lText appendString: @", ..."];
|
||||
node = node->next;
|
||||
break;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
break; /* Just a selector */
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (node != 0 && strcmp(node->name, "desc") == 0)
|
||||
{
|
||||
desc = [self parseDesc: node];
|
||||
|
|
@ -1856,22 +1943,29 @@ loader(const char *url, const char* eid, xmlParserCtxtPtr *ctxt)
|
|||
standards = [self parseStandards: node];
|
||||
}
|
||||
|
||||
if (factory)
|
||||
if (isJava)
|
||||
{
|
||||
NSString *s = [@"+" stringByAppendingString: sText];
|
||||
[self setEntry: s withRef: ref inIndexOfType: @"method"];
|
||||
[self setEntry: sText withRef: ref inIndexOfType: @"method"];
|
||||
}
|
||||
else
|
||||
{
|
||||
NSString *s = [@"-" stringByAppendingString: sText];
|
||||
[self setEntry: s withRef: ref inIndexOfType: @"method"];
|
||||
if (factory)
|
||||
{
|
||||
NSString *s = [@"+" stringByAppendingString: sText];
|
||||
[self setEntry: s withRef: ref inIndexOfType: @"method"];
|
||||
}
|
||||
else
|
||||
{
|
||||
NSString *s = [@"-" stringByAppendingString: sText];
|
||||
[self setEntry: s withRef: ref inIndexOfType: @"method"];
|
||||
}
|
||||
}
|
||||
[text appendFormat: @"<h2><a name=\"%@\">%@</a></h2>\r\n", ref, sText];
|
||||
if (desInit)
|
||||
{
|
||||
[text appendString: @"<b>This is the designated initialiser</b><br>\r\n"];
|
||||
}
|
||||
[text appendFormat: @"%@<br>\r\n", lText];
|
||||
[text appendFormat: @"%@;<br>\r\n", lText];
|
||||
if ([over isEqual: @"subclass"])
|
||||
{
|
||||
[text appendString: @"Your subclass <em>must</em> override this "
|
||||
|
|
@ -1946,7 +2040,11 @@ loader(const char *url, const char* eid, xmlParserCtxtPtr *ctxt)
|
|||
break;
|
||||
|
||||
case XML_ELEMENT_NODE:
|
||||
if (strcmp(node->name, "code") == 0
|
||||
if (strcmp(node->name, "br") == 0)
|
||||
{
|
||||
[text appendString: @"<br>"];
|
||||
}
|
||||
else if (strcmp(node->name, "code") == 0
|
||||
|| strcmp(node->name, "em") == 0
|
||||
|| strcmp(node->name, "file") == 0
|
||||
|| strcmp(node->name, "site") == 0
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue