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

[Norman Walsh <ndw@nwalsh.com>]

/ Trevor Jenkins <trevor.jenkins@suneidesis.com> was heard to say:
| 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?

Hard to say. That example could well be older than the 'returnvalue'
element (so yes, it needs to be updated).

The question of how much markup you should put in your documents is
hard to answer. If time and money are no object, then it's safe to say
that there's never too much markup. By the same token, including no
inline markup for the sake of expediency results in much less useful
documents.

You can't use data that's not marked up, but you don't reap any
benefits from marking up data that you never use.

                                        Be seeing you,
                                          norm

-- 
Norman Walsh <ndw@nwalsh.com>      | To create a little flower is the
http://www.oasis-open.org/docbook/ | labour of ages.--Blake
Chair, DocBook Technical Committee |