GNOME Bugzilla – Bug 621733
Unjustified warning: "return type of member xxx is not documented"
Last modified: 2010-10-11 17:56:30 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.
Confirmed. Should be fixed in the next subversion update.
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.
Created attachment 164948 [details] C header file to reproduce 621733 WARN_NO_PARAMDOC issue
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.
*** Bug 624111 has been marked as a duplicate of this bug. ***
*** Bug 625532 has been marked as a duplicate of this bug. ***
*** Bug 627340 has been marked as a duplicate of this bug. ***
*** Bug 631424 has been marked as a duplicate of this bug. ***
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.
(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.
Hi Olaf, can you please submit a new bug report for this issue? (if it is not already listed)