Re: Help with Doxygen and C structs
- From: gabriele.svelto@xxxxxxxxx
- Date: Tue, 24 Jul 2007 21:27:19 -0000
On 24 Lug, 06:32, "J. Bourne" <n...@xxxxxxxx> wrote:
[snip]
typedef struct _User {
/* ... stuff ... */
struct _User *next_user;
} User;
When documenting the struct and its variables, Doxygen calls the
structure "_User" in the output, instead of the prefered "User".
Is there a way to force Doxygen to identify the struct as "User" instead
of "_User"?
No. User is a typedef of the struct _User type and Doxygen treats it
as any other typedef. If you want to document user you have to either
split the declaration into two parts:
/** comment about struct _User */
struct _User {
/* ... stuff ... */
struct _User *next_user;
}
/** comment about User */
typedef struct _User User;
Or explicitely tell Doxygen what to document:
/** \typedef User
* comment about User */
/** comment about _User */
typedef struct _User {
/* ... stuff ... */
struct _User *next_user;
} User;
.
- References:
- Help with Doxygen and C structs
- From: J. Bourne
- Help with Doxygen and C structs
- Prev by Date: Re: API or standard DLL?
- Next by Date: Re: How important is software maintenance?
- Previous by thread: Re: Help with Doxygen and C structs
- Next by thread: API or standard DLL?
- Index(es):
Relevant Pages
|
