[Doxygen-users] No warning for undocumented member in group
Brought to you by:
dimitri
|
From: Geoff A. <gd...@us...> - 2001-07-18 20:07:08
|
I run doxygen 1.2.8.1 with WARN_IF_UNDOCUMENTED set to YES on the
following file:
---
#ifndef TEST1_HPP
#define TEST1_HPP
//
// Include files.
//
#include <exception>
//
// MyNamespace namespace.
//
namespace MyNamespace
{
/**
* Test1 is a class for testing doxygen style comments.
*
* This the Test1 class's detailed description.
*
* @nosubgrouping
*/
class Test1
{
/**
* @name Additional Class Methods
*/
//@{
/**
* This is method1's brief description.
*
* This is method1's detailed description.
*
* @param m parameter 1
* @param n parameter 2
*
* @returns the return value
*
* @exception std::exception Exception description
*
*/
public:
int method1( int m, int n ) const throw( std::exception );
public:
int method2( int m, int n ) const throw( std::exception );
//
// End Additional Class Methods
//
//@}
public:
int method3( int m, int n ) const throw( std::exception );
//
// End Test1 definition.
//
};
//
// End MyNamespace namespace.
//
}
//
// End include only once.
//
#endif
---
I get the following warning message as excepted:
/home/gdlxn/Test1.hpp:56 Warning: Member method3 of class
MyNamespace::Test1 is not documented.
However, I don't get a warning message for the undocumented method2. Why?
BTW, it would be nice setting WARN_IF_UNDOCUMENTED to YES would warn
about other undocumented entities, such as classes, namespaces, global
functions, etc. in addition to warning about undocumented members.
Geoff Alexander, Ph.D.
919/254-5216 T/L 444-5216
CMVC95 WebDAV Development
IBM Corporation
RTP, NC
|