Re: Thoughts on doxygen for internal documentation

[Phil Edwards <phil at jaj dot com>]

On Wed, Jan 15, 2003 at 02:46:27PM -0500, Diego Novillo wrote:
> For instance, it insists that documentation for arguments should
> be preceded by @param.  It also doesn't understand that we refer
> to the argument names in capitals.  This breaks the flow of the
> comment and makes it harder to read.

libstdc++-v3 has to uglify parameter names, but the names given to
@param don't actually have to match any of the names used in the code.
I take advantage of that to keep the documentation from being soaked with
underscores, e.g.,

    @param  foo  whatever
    @param  bar  whatever
    ...
    void standard_function (int __foo, int __bar) ...


Phil

-- 
I would therefore like to posit that computing's central challenge, viz. "How
not to make a mess of it," has /not/ been met.
                                                 - Edsger Dijkstra, 1930-2002