2
.\"written by Adrian Robert <arobert@cogsci.ucsd.edu>
4
.\"Process this file with
5
.\"groff -man -Tascii gsdoc.7
7
.TH GSDOC 1 "March 2004" GNUstep "GNUstep System Manual"
9
GSDoc \- GNUstep XML documentation format
12
GSDoc is an XML language designed specifically for writing documentation for
13
the GNUstep project. In practice, that means that it is designed for writing
14
about software, and in particular, for writing about Objective-C classes.
17
The GSDoc markup language is defined by an SGML DTD, that specifies the tags
18
that may be used in marking up a GSDoc document, and how and where those tags
19
may be placed. The reader is encouraged to consult the DTD directly on any
20
points that the other documentation leaves unclear. The DTD is stored under
21
\fI$GNUSTEP_ROOT/System/Library/DTDs\fR in a standard GNUstep installation.
24
GSDoc may be written by hand, but it is primarily autogenerated from
25
Objective-C source files by a tool called \fIautogsdoc\fR.
26
See the man page for that tool for more information. This tool also converts
27
GSDoc into HTML for viewing. In the future it is planned to convert the XML
28
into HTML, texinfo, man page, and other formats using XSLT.
30
.SH OTHER DOCUMENTATION
31
The primary documentation source for GSDoc is the GNUstep system HTML
32
documentation, under the Tools section. In a standard GNUstep installation
33
this should be found under
34
\fI$GNUSTEP_ROOT/System/Library/Documentation/Developer/Tools\fR.
38
autogsdoc(1), GNUstep(7)
42
The GSDoc format was developed for GNUstep based on the earlier GDML SGML
45
This manual page first appeared in gnustep-base 1.9.2 (March 2004).
49
was defined by Richard Frith-McDonald <rfm@gnu.org>
added
removed
Tools/gsdoc.7
