Doxygen - another sample, preliminary comments

[Gabriel Dos Reis]

Rich Churcher <churcher@ihug.com.au> writes:

[...]

| On that note: perhaps we should consider using the Doxygen comment
| format in future, as this will have little effect on the current
| sources but will make sure any comments get included in the
| documentation generation process.  For those that don't know, they
| look like this:
| 
|   /// A single-line comment
| 
|   /** A multi-line 
|       comment. */

Well, I have some trouble to follow this discussion (partly because of
lack of time).  What exactly is it about? Documenting V3 internals? Or
documenting what should help users to properly and efficiently use V3?

I disagree with the idea of exposing V3 internals to users, if that
was the idea under discussion. 

-- Gaby