tags:

views:

446

answers:

2

How can I tell Doxygen to use the first declaration in this code:

typedef struct _decor_extents {
    int left;
    int right;
    int top;
    int bottom;
} decor_extents_t;

Cheers, Kris

A: 

Do you want Doygen to use struct _decor_extents, rather than decor_extents_t?

If so, don't use a typedef. In other words, remove the typedef and the type name (decor_extents_t).

This does mean that any variable of this type will have to be declared as struct _decor_extents, rather than decor_extents_t.

Out of interest, why do you want to do this?

Steve Melnikoff
Furthermore, identifiers starting with `_` are by convention considered privates, so could be that removing the typedef doxygen will skip the whole type.
ntd
This for documenting the new 0.9 Compiz branch, which is basically 100% undocumented until this effor.t
Kristopher Ives
A: 

You could do either the aforementioned suggestion of reorganizing the struct:

typedef struct decor_extents_t { ... }

There is also a trick with doxygen itself for structs and classes to specify their name and start the documentation for them. See the manual here.

s1n