mirror of
https://github.com/gnustep/libs-base.git
synced 2025-05-22 05:02:00 +00:00
Added some files I missed.
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@18992 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
parent
c85351824b
commit
f139273ffa
8 changed files with 1533 additions and 0 deletions
49
Tools/gsdoc.7
Normal file
49
Tools/gsdoc.7
Normal file
|
@ -0,0 +1,49 @@
|
|||
.\"gsdoc(1) man page
|
||||
.\"written by Adrian Robert <arobert@cogsci.ucsd.edu>
|
||||
.\"
|
||||
.\"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
|
||||
\fI$GNUSTEP_ROOT/System/Library/DTDs\fR in a standard GNUstep installation.
|
||||
|
||||
.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
|
||||
\fI$GNUSTEP_ROOT/System/Library/Documentation/Developer/Tools\fR.
|
||||
|
||||
.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>
|
Loading…
Add table
Add a link
Reference in a new issue