OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

docbook message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]


Subject: DOCBOOK: Marking up C/C++ functions


I'm working on a manual for a function library. For various reasons not
least that several of theproducts derived form this document will
searchable I want to markup "everything". So I have things like this:

<funcprotype>
<funcdef>
<returnvalue>BLAHapi</returnvalue> <function>BlhDoSomethingForaUser</function>
</funcdef>
   <parameter>char * <varname>group</varname></parameter>
   <parameter>char * <varname>user</varname></parameter>
</funcprototype>

When I checked the examples in "DocBook: The Definitive Guide" I see that
the equivalent is:

<funcprototype>
<funcdef>BLAHapi <function>BldDoSomethingForaUser</function></funcdef>
   <parameter>char * <varname>group</varname></parameter>
   <parameter>char * <varname>user</varname></parameter>
</funcprototype>

So I wonder whether this is just "laziness" on the part of the author of
the book :-) or am I being excessive in my markup?

Regards, Trevor

British Sign Language is not inarticulate handwaving; it's a living language.
Support the campaign for formal recognition by the British government now!

-- 

<>< Re: deemed!



[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]


Powered by eList eXpress LLC