Help with Doxygen and C structs



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"?

I haven't been able to find anything in Doxygen's documentation that
addresses this issue.

Thanks,
JB
.



Relevant Pages

  • Re: [patch 6/13] signal/timer/event fds v8 - timerfd core ...
    ... no. Gain is not worth the plug into the structure design IMO. ... payoff in putting work into documenting the struct, its fields, the ... relationship between this struct and other structs, ... the patch description describes the API ...
    (Linux-Kernel)
  • Re: Help with Doxygen and C structs
    ... self-referential structs. ... we have a struct like the ... When documenting the struct and its variables, ... "typedef struct User", and change the variable to type "struct ...
    (comp.programming)
  • Re: Self-referential structs
    ... Gabor Bukovics wrote: ... > For creating self-referential structs that can be instantiated as ... > typedef struct SelfReferential { ... > int i; ...
    (alt.comp.lang.learn.c-cpp)
  • Re: Self-referential structs
    ... In article, Gabor Bukovics ... >For creating self-referential structs that can be instantiated as ... > typedef struct SelfReferential { ... > int i; ...
    (alt.comp.lang.learn.c-cpp)