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 621733 - Unjustified warning: "return type of member xxx is not documented"
Unjustified warning: "return type of member xxx is not documented"
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.7.0
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
: 624111 625532 627340 631424 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2010-06-16 06:29 UTC by Hubert Mackenberg
Modified: 2010-10-11 17:56 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
C header file to reproduce 621733 WARN_NO_PARAMDOC issue (18.60 KB, text/x-h)
2010-06-30 07:32 UTC, Alexander Dahl
Details

Description Hubert Mackenberg 2010-06-16 06:29:19 UTC
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:

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

Note:
 - the generated documentation is correct
 - <FOO>:1: should be replaced by file name and line number
 - the bug does not appear in version 1.6.3.
Comment 1 Dimitri van Heesch 2010-06-16 19:14:31 UTC
Confirmed. Should be fixed in the next subversion update.
Comment 2 Dimitri van Heesch 2010-06-25 11:48:56 UTC
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.
Comment 3 Alexander Dahl 2010-06-30 07:32:39 UTC
Created attachment 164948 [details]
C header file to reproduce 621733 WARN_NO_PARAMDOC issue
Comment 4 Alexander Dahl 2010-06-30 07:33:24 UTC
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.
Comment 5 Dimitri van Heesch 2010-06-30 19:09:34 UTC
Confirmed. Should be fixed in the next subversion update.
Comment 6 Dimitri van Heesch 2010-07-11 17:18:33 UTC
*** Bug 624111 has been marked as a duplicate of this bug. ***
Comment 7 Dimitri van Heesch 2010-07-29 19:40:10 UTC
*** Bug 625532 has been marked as a duplicate of this bug. ***
Comment 8 Dimitri van Heesch 2010-08-20 20:47:57 UTC
*** Bug 627340 has been marked as a duplicate of this bug. ***
Comment 9 Dimitri van Heesch 2010-10-06 18:50:46 UTC
*** Bug 631424 has been marked as a duplicate of this bug. ***
Comment 10 Dimitri van Heesch 2010-10-09 08:19:11 UTC
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.
Comment 11 Olaf Tauber 2010-10-11 14:30:44 UTC
(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 (<FOO>:1:) is still present. I think, Definition::docLine() and Definition::docFile() should also look at  m_impl->brief when m_impl->details is 0.
Comment 12 Dimitri van Heesch 2010-10-11 17:56:30 UTC
Hi Olaf, can you please submit a new bug report for this issue? (if it is not already listed)