Hello Folks,
I’m having problems with documenting friends in C++.
doxygen-1.8.10
WARN_IF_UNDOCUMENTED YES
WARN_IF_DOC_ERROR YES
WARN_NO_PARAMDOC YES
DISTRIBUTE_GROUP_DOC YES
EXTRACT_ALL no
This file produces three warnings, as listed in the comments, but only when the
\file comment block is included.
friends.h:
----------
/**
* \file
* \brief Example of doxymenting friend functions.
* Removing this block clears all the warnings.
*/
/** Friends example. */
class Friends
{
public:
/**
* @{
* \brief Friend function.
*
* This produces a "member not documented" error on
* the declaration of Second, outside the class, below.
* Both functions are documented in the output, however.
*/
friend void First (void);
friend void Second (void);
/** @} */
/**
* @{
* \brief More friends: this produces "member not documented" errors
* for both functions, and doesn't produce output; note this block
* only has a brief description.
*/
friend void Third (void);
friend void Fourth (void);
/** @} */
}; // class Friends
void First (void);
void Second (void);
void Third (void);
void Fourth (void);
doxygen.log:
------------
friends.h:1: warning: Member Fourth(void) (function) of file friends.h is not
documented.
friends.h:1: warning: Member Second(void) (function) of file friends.h is not
documented.
friends.h:1: warning: Member Third(void) (function) of file friends.h is not
documented.
Also note that the line numbers in the warning log are incorrect.
Any suggestions?
Peter
_______________________________________________________________________
Dr. Peter D. Barnes, Jr. Physics Division
Lawrence Livermore National Laboratory Physical and Life Sciences
7000 East Avenue, L-50 email: [email protected]
P. O. Box 808 Voice: (925) 422-3384
Livermore, California 94550 Fax: (925) 423-3371
------------------------------------------------------------------------------
Don't Limit Your Business. Reach for the Cloud.
GigeNET's Cloud Solutions provide you with the tools and support that
you need to offload your IT needs and focus on growing your business.
Configured For All Businesses. Start Your Cloud Today.
https://www.gigenetcloud.com/
_______________________________________________
Doxygen-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
