After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 627340 - typedef documentation bug
typedef documentation bug
Status: RESOLVED DUPLICATE of bug 621733
Product: doxygen
Classification: Other
Component: general
1.7.1
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2010-08-19 07:43 UTC by Zoltan Kocsi
Modified: 2010-08-20 20:47 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Zoltan Kocsi 2010-08-19 07:43:00 UTC
When documenting a typedef (in straight C code) like this:

/**
* The representation of frobo.
*
* The frobo_t type is actually an unsigned integer than can hold 
* the unique identifier for every frobo you could ever have. The value
* of 0 is special, because it indicates something that only frobos
* would understand.
*/

typedef unsigned int frobo_t;

then Doxygen 1.7.1 to emits:

frobo.h:25: warning: return type of member frobo_t is not documented

If the comment is a comment after the typedef, like:

typedef unsigned int frobo_t; //<! This is the frobo type.

then the warning is not generated.

It seems that if you use block comment in front of the typedef, then Doxygen insist of it having a return value. If you specify a \returns in the block, then it is happy.

The 1.6 series did not have this bug.
Comment 1 Dimitri van Heesch 2010-08-20 20:47:57 UTC
Confirmed. Should be fixed in the next subversion update.

*** This bug has been marked as a duplicate of bug 621733 ***