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

[Johan E. <joh...@ua...>]

Hi guys,
            has anyone tested the configuration option=20
MAX_INITIALIZER_LINES, I did that for enums by setting it to zero and=20
then the value disappeared......I don't know if this solves your=20
problems with different defines, enums, etc. but to introduce another=20
command like \show_values, \show_definition seems to be overkill since=20
it already exists the commands \showinitializer and \hideinitializer......

In general, I think it is good to provide different options to customize=20
e.g. a tool. However, when/if the options starts to depend on each in=20
one way or another, the complexibility to maintain and test the=20
different combinations increases (exponential?) especially as for a tool=20
like Doxygen where a number of output formats is also provided....

I think for Doxygen, it provides a lot of options already and adding new=20
options should be considerred very carefully (which I am sure of is done=20
by Dimitri) and instead concentrate of developing the tool with=20
increased functionality like e.g. the xml parser.

Just some thoughts,
                             Johan

Carlo Wood wrote:

>On Mon, Nov 19, 2001 at 06:27:04PM +0100, Toni Moreno Gim=E9nez 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)
>