[DOC++] enum member documentation
Brought to you by:
adragos
|
From: <Ber...@gm...> - 2003-03-22 14:46:57
|
Hi,
I often use the construct:
typedef enum
{
item_1,
item_2,
...
item n
} TMyEnumType;
Now I would like to document the existence of the type and of course the =
meaning of each enum item.
Right now, doc++ forces me to use the construct:
/// this is my enum
enum _TMyEnumType
{
item_1,
item_2,
...
item n
};
/// this is the type made from my enum
typedef enum _TMyEnumType TMyEnumType;
which is bothersome.
Moreover, doc++ only lists the last item of the enum definition.
It would be desirable to have something like this:
/// this is my enum type, which can be used for some funky purpose
typedef enum
{
item_1, /// used for tiddelypush
item_2, /// triggers whatnot
...
item n /// make you dizzy
} TMyEnumType;
which results in
* Type: TMyEnumType
this is my enum type, which can be used for some funky purpose
possible values are:
- item_1 =20
used for tiddelypush
item_2 =20
triggers whatnot
...
item n =20
make you dizzy
Is it possible to produce such an output with doc++?
Greetings,
bernd hofner | diesterwegstr. 3 | 57078 siegen germany
tel: +49 (0)271/20266 | fax: +49 (0)271/20758 | mobile: +49 =
(0)170/2813683=20
Mail: Ber...@gm...
|