This is the mail archive of the
docbook@lists.oasis-open.org
mailing list for the DocBook project.
Re: Code markup.
- To: docbook at lists dot oasis-open dot org
- Subject: Re: DOCBOOK: Code markup.
- From: Norman Walsh <ndw at nwalsh dot com>
- Date: 23 Jun 2000 14:31:46 -0400
- References: <NDBBKDFLFKGBNPJPGKDFCEDPCFAA.dave.pawson@virgin.net>
- Reply-To: docbook at lists dot oasis-open dot org
/ "Dave Pawson" <dave.pawson@virgin.net> was heard to say:
[...]
| <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>
[...]
| 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?
Without more context, I have to admit I'm a little confused. For the
functiony parts, I'd say:
<funcdef>Bool <function>xf86GetFlipPixels</function></funcdef>
But from the description of -flippixels, I think it should be a simple
parameter or option, not a funcparam since it's not a parameter to a
function.
Does that help?
Be seeing you,
norm
--
Norman Walsh <ndw@nwalsh.com> | If a little knowledge is
http://www.oasis-open.org/docbook/ | dangerous, where is the man who
Chair, DocBook Technical Committee | has so much as to be out of
| danger?--T. H. Huxley