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: "Dave Pawson" <dave dot pawson at virgin dot net>
- Date: Tue, 4 Jul 2000 19:15:06 +0100
- Reply-To: docbook at lists dot oasis-open dot org
| My need is to talk about an instance use of a function, its params
| its return values etc.
|
| How about
| <para> <cmdsynopsis sepchar=" ">
No reason to put the cmdsynopsis inside a para if you don't want to.
Fine, one level less of markup.
| <command moreinfo="none">xf86GetFlipPixels()</command>
That's a function, not a command.
For which the markup is...?
| <arg choice="opt" rep="norepeat">-flippixels</arg>
This is the odd part, -flippixels is clearly an option that you would
pass to the, um, xinit (?) program, but xf86GetFlipPixels must return
whether or not that option was set.
-flippixels is not properly an argument to xf86GetFlipPixels().
Now confessing my ignorance, I'll have to ask the question on
xfree86 :-| (what was that entity again ?)
and get back on that one.
*were* it a command with an argument
would <command> xfreeGetFlipPixels</command<arg
choice="optional"> -flippexels</arg>
be the right markup?
(still wanting to learn)
Regards, daveP