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

Unjustified warning: "return type of member xxx is not documented" (Origin: bugzilla #621733) #3804

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 normal in component general for ---
Reported in version 1.7.0 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2010-06-16 06:29:19 +0000, Hubert Mackenberg wrote:

For a simple define statement Doxygen gives the warning

Warning: return type of member xxx is not documented

if the following settings are active:

ALWAYS_DETAILED_SEC = YES
WARN_NO_PARAMDOC = YES

Example:

  1. Create a file test.h with this content:

     /// @defgroup test test
     /// @{
    
     /// some documentation
     #define FOO 42
    
     /// @}
    
  2. Create an default configuration file using:

    doxygen -g

  3. In Doxfile, set:

    INPUT = test.h
    ALWAYS_DETAILED_SEC = YES
    WARN_NO_PARAMDOC = YES

  4. Run doxygen:

    doxygen

Doxygen complains:

:1: Warning: return type of member FOO is not documented

Note:

  • the generated documentation is correct
  • :1: should be replaced by file name and line number
  • the bug does not appear in version 1.6.3.

On 2010-06-16 19:14:31 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2010-06-25 11:48:56 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.1. 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-06-30 07:32:39 +0000, Alexander Dahl wrote:

Created attachment 164948
C header file to reproduce 621733 WARN_NO_PARAMDOC issue

On 2010-06-30 07:33:24 +0000, Alexander Dahl wrote:

Confirmed for 1.7.1 on Windows XP. I'll attach a header file with definitions of different data types to reproduce this. In the Doxyfile I changed the following options (according to red marked options in Doxywizard):

OPTIMIZE_OUTPUT_FOR_C = YES
WARN_NO_PARAMDOC = YES
WARN_LOGFILE = doxygen.log
GENERATE_LATEX = NO

Especially the WARN_NO_PARAMDOC seems to be of importance. I get no warnings if I set this to NO.

On 2010-06-30 19:09:34 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2010-07-11 17:18:33 +0000, Dimitri van Heesch wrote:

*** Bug 624111 has been marked as a duplicate of this bug. ***

On 2010-07-29 19:40:10 +0000, Dimitri van Heesch wrote:

*** Bug 625532 has been marked as a duplicate of this bug. ***

On 2010-08-20 20:47:57 +0000, Dimitri van Heesch wrote:

*** Bug 627340 has been marked as a duplicate of this bug. ***

On 2010-10-06 18:50:46 +0000, Dimitri van Heesch wrote:

*** Bug 631424 has been marked as a duplicate of this bug. ***

On 2010-10-09 08:19:11 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.2. 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-10-11 14:30:44 +0000, Olaf Tauber wrote:

(In reply to comment # 10)

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.2. 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.

The "Unjustified warning"-part of this bug seems to be fixed in 1.7.2, the problem with the missing file and line references (:1:) is still present. I think, Definition::docLine() and Definition::docFile() should also look at m_impl->brief when m_impl->details is 0.

On 2010-10-11 17:56:30 +0000, Dimitri van Heesch wrote:

Hi Olaf, can you please submit a new bug report for this issue? (if it is not already listed)

@doxygen doxygen closed this Jul 2, 2018

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