mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-20 23:11:59 +00:00
dd2d86cb7e
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@24901 72102866-910b-0410-8b05-ffd578937521
54 lines
2 KiB
Groff
54 lines
2 KiB
Groff
.\"gsdoc(1) man page
|
|
.\"written by Adrian Robert <arobert@cogsci.ucsd.edu>
|
|
.\"Copyright (C) 2005 Free Software Foundation, Inc.
|
|
.\"
|
|
.\"Process this file with
|
|
.\"groff -man -Tascii gsdoc.7
|
|
.\"
|
|
.TH GSDOC 1 "March 2004" GNUstep "GNUstep System Manual"
|
|
.SH NAME
|
|
GSDoc \- GNUstep XML documentation format
|
|
|
|
.SH DESCRIPTION
|
|
GSDoc is an XML language designed specifically for writing documentation for
|
|
the GNUstep project. In practice, that means that it is designed for writing
|
|
about software, and in particular, for writing about Objective-C classes.
|
|
|
|
.SH DEFINITION
|
|
The GSDoc markup language is defined by an SGML DTD, that specifies the tags
|
|
that may be used in marking up a GSDoc document, and how and where those tags
|
|
may be placed. The reader is encouraged to consult the DTD directly on any
|
|
points that the other documentation leaves unclear. The DTD is stored under
|
|
\fIGNUSTEP_SYSTEM_LIBRARY/DTDs\fR in a standard GNUstep installation...
|
|
where GNUSTEP_SYSTEM_LIBRARY is defined in the GNUstep configuration
|
|
file (GNUstep.conf).
|
|
|
|
.SH USAGE
|
|
GSDoc may be written by hand, but it is primarily autogenerated from
|
|
Objective-C source files by a tool called \fIautogsdoc\fR.
|
|
See the man page for that tool for more information. This tool also converts
|
|
GSDoc into HTML for viewing. In the future it is planned to convert the XML
|
|
into HTML, texinfo, man page, and other formats using XSLT.
|
|
|
|
.SH OTHER DOCUMENTATION
|
|
The primary documentation source for GSDoc is the GNUstep system HTML
|
|
documentation, under the Tools section. In a standard GNUstep installation
|
|
this should be found under
|
|
\fIGNUSTEP_SYSTEM_DOC/Developer/Tools\fR...
|
|
where GNUSTEP_SYSTEM_DOC is defined in the GNUstep configuration
|
|
file (GNUstep.conf).
|
|
|
|
.SH SEE ALSO
|
|
.P
|
|
autogsdoc(1), GNUstep(7)
|
|
.P
|
|
|
|
.SH HISTORY
|
|
The GSDoc format was developed for GNUstep based on the earlier GDML SGML
|
|
language.
|
|
.P
|
|
This manual page first appeared in gnustep-base 1.9.2 (March 2004).
|
|
.P
|
|
.SH AUTHORS
|
|
.B gsdoc
|
|
was defined by Richard Frith-McDonald <rfm@gnu.org>
|