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 557164 - WARN_NO_PARAMDOC does not report missing "return" comments
WARN_NO_PARAMDOC does not report missing "return" comments
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: doxywizard
1.5.7
Other All
: Normal enhancement
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2008-10-20 23:02 UTC by Ron
Modified: 2010-07-26 17:25 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
This should patch the problem. (661 bytes, patch)
2010-02-25 16:31 UTC, peter.myerscough-jackopson 		none Details | Review

Description Ron 2008-10-20 23:02:03 UTC 
Please describe the problem:
WARN_NO_PARAMDOC does not report missing "return" comments. When WARN_NO_PARAMDOC is set to YES the doxywizard should report missing @return (\return) when the function has a return (i.e., an undocumented return).  However, it does not report them.

Steps to reproduce:
1. Create a function that contains a return
2. Document the function with the exception of the return
3. Run Doxywizard with WARN_NO_PARAMDOC set to YES


Actual results:
Doxywizard does not report any warnings.

Expected results:
Doxywizard reporting the undocumented returns.

Does this happen every time?
Yes

Other information:
Comment 1 peter.myerscough-jackopson 2010-02-25 16:31:55 UTC 
Created attachment 154701 [details] [review]
This should patch the problem.

the checking for if a function was a constructor/destructor looked inverted, and wrong.
Comment 2 Dimitri van Heesch 2010-04-10 14:56:02 UTC 
Thanks Peter. I'll include your patch in the next subversion update.
Comment 3 Dimitri van Heesch 2010-06-15 11:21:37 UTC 
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.0. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.
Comment 4 Rick Pearson 2010-07-26 17:25:25 UTC 
Bug appears to still be present in Doxywizard 1.7.1.