Re: Help with Doxygen and C structs
- From: "J. Bourne" <none@xxxxxxxx>
- Date: Mon, 23 Jul 2007 22:01:32 -0700
On Mon, 23 Jul 2007 21:32:01 -0700
"J. Bourne" <none@xxxxxxxx> wrote:
Hello,
I'm trying to use Doxygen to document the source of a project I'm
working on in C. The problem I'm having is correctly documenting
self-referential structs. For instance, we have a struct like the
following:
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"?
[snip]
Well, it occurred to me: why not replace "typedef struct _User" with
"typedef struct User", and change the variable to type "struct
User"? Well, sure enough, that fixed my problem.
Thanks anyway,
JB
.
- References:
- Help with Doxygen and C structs
- From: J. Bourne
- Help with Doxygen and C structs
- Prev by Date: Help with Doxygen and C structs
- Next by Date: API or standard DLL?
- Previous by thread: Help with Doxygen and C structs
- Next by thread: Re: Help with Doxygen and C structs
- Index(es):
Relevant Pages
|
