New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WARN_NO_PARAMDOC does not report missing "return" comments (Origin: bugzilla #557164) #3139

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity enhancement in component doxywizard for ---
Reported in version 1.5.7 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2008-10-20 23:02:03 +0000, Ron wrote:

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:

On 2010-02-25 16:31:55 +0000, peter.myerscough-jackopson@macltd.com wrote:

Created attachment 154701
This should patch the problem.

the checking for if a function was a constructor/destructor looked inverted, and wrong.

On 2010-04-10 14:56:02 +0000, Dimitri van Heesch wrote:

Thanks Peter. I'll include your patch in the next subversion update.

On 2010-06-15 11:21:37 +0000, Dimitri van Heesch wrote:

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.

On 2010-07-26 17:25:25 +0000, Rick Pearson wrote:

Bug appears to still be present in Doxywizard 1.7.1.

@doxygen doxygen closed this Jul 2, 2018

@doxygen doxygen added the doxywizard label Jul 19, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment