This is the mail archive of the
docbook@lists.oasis-open.org
mailing list for the DocBook project.
Code markup.
- To: "Docbook at Lists dot Oasis-Open dot Org" <docbook at lists dot oasis-open dot org>
- Subject: DOCBOOK: Code markup.
- From: "Dave Pawson" <dave dot pawson at virgin dot net>
- Date: Fri, 23 Jun 2000 16:41:39 +0100
- Reply-To: docbook at lists dot oasis-open dot org
In one of the documents I'm doing, I have 'descriptions'
of whats happening.
E.g.
<p><tt>Bool xf86GetFlipPixels()</tt></p>
<p>Returns <tt>TRUE</tt> if <tt>-flippixels</tt> is
present on the command line, and <tt>FALSE</tt> otherwise.</p>
<p><tt>const char *xf86GetServerName()</tt></p>
<p>Returns the name of the X server from the command line.</p>
This is marked up ~according to the linuxdoc DTD :-)
I've no intention of working on it in this DTD,
but when I get it across to docbook (x)
I'd like to know how it should be marked up.
funcdef ok for the function names,
funcparams for -flippixels is my initial guess, I'd like it
confirming please.
I have the distinct feeling that they are related to function
definitions rather than descriptions since they are part of funcsynopsis
, or am I being too pedantic?
Any assistance appreciated.