This is the mail archive of the docbook@lists.oasis-open.org mailing list for the DocBook project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]

structured funcsynopsis formatting


I would like it if the following:

<funcsynopsis>
  <funcprototype>
    <funcdef>void <function>gimp_pixel_rgn_init</function></funcdef>
    <paramdef>GPixelRgn* <parameter>pr</parameter></paramdef>
    <paramdef>GDrawable* <parameter>drawable</parameter></paramdef>
    <paramdef>int <parameter>x</parameter></paramdef>
  </funcprototype>
</funcsynopsis>

were formatted more like this:

void gimp_pixel_rgn_init(GPixelRgn* pr,
                         GDrawable* drawable,
                         int        x);
than this:

void gimp_pixel_rgn_init (GPixelRgn* pr, GDrawable* drawable, int x);

As when a function has enough arguments that they wrap around more than
one line in the output, readability drops considerably.  Any pointers on
how to achieve this?  Funcsynopsis seems to ignore line breaks and
indentation even when used in a linespecific programlisting.

Also, I would like to provide syntax highlighting (aka prettyprinting)
in included programlistings.  Anyone have a trick for this?  Lacking any
better ideas, the source can always be marked by hand with <type>,
<varname>, <function>, etc, if the sample is small enough.

But there is one element found in most prettyprinters that DocBook
lacks, though: a source-comment tag, to mark up /* this */ .

Regards,

  - Kevin

-- 
Kevin.Turner@oberlin.edu | OpenPGP encryption welcome here, see X-DSA-Key


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]