Re: DOCBOOK: Code markup.

["Juan R. Migoya" <promo804 at hsoft dot es>]

This is an example of what I use to document software functions (only one in the
example):
I have no return values (all are params) but I think it's not important.
(Sorry: It's in spanish)
-------------------------------------------------------------
<refentry id="if0102">
<refnamediv>
 <refname>INICIALIZACION_USART</refname>
 <refpurpose>Inicialización del USART</refpurpose>
</refnamediv>
<refsect1>
 <title>Synopsis</title>
 <para>Esta función se utiliza para inicializar la USART del módulo procesador
BG0090
 y las del módulo BL0150</para>

 <para>Es necesario llamar a esta función para cada una de las puertas serie que
se vayan
 a utilizar.  Siempre es conveniente poder comprobar el resultado de la
inicialización, utilizando
 para ello el parámetro <parameter>STATUS</parameter></para>
</refsect1>
<refsect1>
 <title>Par&aacute;metros</title>

<varlistentry>
 <term><parameter>MODULO_INT<type>&nbsp;(INT)</type></parameter></term>
  <listitem><para>valor tipo word, de 0 a 15, que indica la posición, en el bus
TBX, del módulo BL0150.</para></listitem>
  </varlistentry>

  <varlistentry>
 <term><parameter>CHASIS_INT<type>&nbsp;(INT)</type></parameter></term>
  <listitem><para> Valor de tipo Word, de 0 a 3, que indica el número de chasis
en el que se encuentra el módulo BL0150.</para></listitem>
  </varlistentry>
 </variablelist>
</refsect1>
</refentry>
------------------------------------------------------------------

Perhaps there it's something similar what you need.

Regards,

Juan R. Migoya

Dave Pawson wrote:

> Juan R. Migoya
>      Sent: 25 June 2000 12:12
>
>      Check te <refentry> element. Perhaps you find more options
>      there to play
>      with.
>
> Again, its a 'maybe', described as
> <quote>RefEntry -- A reference page (originally a UNIX man-style reference
> page)</quote>
> Which presumably means its a 'how to use' instance.
>
> The tdg examples appear way out (tdg\html\refentry.html)
> (no formatted output Norm?)
>
> My need is to talk about an instance use of a function, its params
> its return values etc.
>
> How about
> <para> <cmdsynopsis sepchar=" ">
>   <command moreinfo="none">xf86GetFlipPixels()</command>
>   <arg choice="opt" rep="norepeat">-flippixels</arg>
>   <!-- one of (sbr group arg command) -->
>  </cmdsynopsis>
>  <para>Returns <computeroutput>TRUE</computeroutput> if -flippixels is
> present on the command line, and <computeroutput>FALSE</computeroutput>
> otherwise</para></para>
>
> Which, as you said ;-), I found via that command.
>
> Regards, DaveP
>