Skip to content
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

Not warning of undocumented function parameters (Origin: bugzilla #678684) #4771

Closed
doxygen opened this issue Jul 2, 2018 · 1 comment
Closed

Comments

@doxygen
Copy link
Owner

doxygen commented Jul 2, 2018

status NEW severity major in component general for ---
Reported in version 1.8.1 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2012-06-23 22:17:47 +0000, Richard Rowley wrote:

Created attachment 217100
doxygen configuration file

No warnings issues for undocumented function parameters. This is a stand-
along (non-class) function. WARNINGS=YES,
WARN_IF_UNDOCUMENTED=YES,WARN_NO_PARAMDOC=YES.

test source:
#include <string>

//! \brief gets merchant code
static std::string getMerchCode(const int& i)
{
   return (i == 0 ? "0" : "Other");
}


stdout from entry of: doxygen Doxytst

Searching for include files...
Searching for example files...
Searching for images...
Searching for dot files...
Searching for msc files...
Searching for files to exclude
Searching for files to process...
Reading and parsing tag files
Preprocessing /develop/home/rich/build/2012_2/src/tst.cpp...
Parsing file /develop/home/rich/build/2012_2/src/tst.cpp...
Building group list...
Building directory list...
Building namespace list...
Building file list...
Building class list...
Associating documentation with classes...
Computing nesting relations for classes...
Building example list...
Searching for enumerations...
Searching for documented typedefs...
Searching for members imported via using declarations...
Searching for included using directives...
Searching for documented variables...
Building member list...
Searching for friends...
Searching for documented defines...
Computing class inheritance relations...
Computing class usage relations...
Flushing cached template relations that have become invalid...
Creating members for template instances...
Computing class relations...
Add enum values to enums...
Searching for member function documentation...
Building page list...
Search for main page...
Computing page relations...
Determining the scope of groups...
Sorting lists...
Freeing entry tree
Determining which enums are documented
Computing member relations...
Building full member lists recursively...
Adding members to member groups.
Computing member references...
Inheriting documentation...
Generating disk names...
Adding source references...
Adding xrefitems...
Sorting member lists...
Computing dependencies between directories...
Generating citations page...
Counting data structures...
Resolving user defined references...
Finding anchors and sections in the documentation...
Combining using relations...
Adding members to index pages...
Generating style sheet...
Generating search indices...
Generating example documentation...
Generating file sources...
Generating file documentation...
Generating docs for file tst.cpp...
Generating page documentation...
Generating group documentation...
Generating class documentation...
Generating namespace index...
Generating graph info page...
Generating directory documentation...
Generating index page...
Generating page index...
Generating module index...
Generating namespace index...
Generating namespace member index...
Generating annotated compound index...
Generating alphabetical compound index...
Generating hierarchical class index...
Generating member index...
Generating file index...
Generating file member index...
Generating example index...
finalizing index lists...
symbol cache used 31/65536 hits=524 misses=31
lookup cache used 129/65536 hits=632 misses=196
finished...

On 2012-06-23 22:19:27 +0000, Richard Rowley wrote:

Note I set as major issue as I rely on the warning to assure I and others
fully document applications.

On 2018-05-11 13:47:40 +0000, albert wrote:

Problem here is the setting of EXTRACT_ALL = YES, signaling:
If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
documentation are documented, even if no documentation was available.
Private class members and static file members will be hidden unless the
EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.

Note This will also disable the warnings about undocumented members that are
normally produced when WARNINGS is set to YES.

As a side note, it does not influence the setting of WARN_IF_DOC_ERROR

I've just pushed a proposed patch to github (pull request 719,
https://github.com/doxygen/doxygen/pull/719).
@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Jul 7, 2018
@doxygen
Copy link
Owner Author

doxygen commented Aug 8, 2019

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.8.16.
Please verify if this is indeed the case. Reopen the
issue if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Aug 8, 2019
@doxygen doxygen closed this as completed Aug 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants