Re: [Doxygen-users] Documenting a "libray reference Manual" using Doxygen.

[Carlo W. <ca...@al...>]

On Mon, Nov 19, 2001 at 06:27:04PM +0100, Toni Moreno Giménez wrote:
> library users need  ONLY. to know the label of each format type.

I agree.  The nature of enums is such that in general the value
is 'internal', and showing it to a user messes up the cleanness
of the documentation as it is not relevant.
In SOME cases it is important to know the values, when enums
are correlated somehow, but that is in general Bad Programming
then (and constant integers should have been used instead).

The default should be NOT to show enum values.  An option
*per* enum could be added to show it.  For example:

/**
 * \show_values
 */
enum foo {
...

Same thing for macro functions, in general the definition of
the macro should be hidden and only shown when explicitely
requested:

/**
 * \show_definition
 */
#define FOO(x) (x * x * x - 2 * x + 3)

-- 
Carlo Wood <ca...@al...>