[doxygen] Stop warnings from NS_LOG_COMPONENT_DEFINE and NS_OBJECT_ENSURE_REGISTERED

This commit is contained in:
Peter D. Barnes, Jr.
2014-03-05 16:55:49 -08:00
parent bfeb265434
commit 104ff32b23
3 changed files with 5 additions and 22 deletions

View File

@@ -1660,8 +1660,10 @@ INCLUDE_FILE_PATTERNS =
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
PREDEFINED = NS3_ASSERT_ENABLE \
NS3_LOG_ENABLE
# Function like macros at file global scope typically need to be here:
PREDEFINED = NS_LOG_COMPONENT_DEFINE()=1 \
NS_OBJECT_ENSURE_REGISTERED()=1
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.

View File

@@ -156,16 +156,6 @@ void LogComponentDisableAll (enum LogLevel level);
* ns3::LogComponentDisable functions or with the NS_LOG
* environment variable.
*
* To create a log component Foo, at the top of foo.cc:
*
* \code
* NS_LOG_COMPONENT_DEFINE ("Foo")
* ;
* \endcode
*
* Note the closing ';' is not on the same line; this prevents
* Doxygen from spuriously warning that the macro invocation is undocumented.
*
* \param name a string
*/
#define NS_LOG_COMPONENT_DEFINE(name) \

View File

@@ -26,23 +26,14 @@
#include <list>
/**
* \ingroup object
* \brief Register the class in the ns-3 factory.
*
* This macro should be invoked once for every class which
* defines a new GetTypeId method.
*
* Given a class Foo, the .cc implementation should begin
*
* \code
* NS_OBJECT_ENSURE_REGISTERED (Foo)
* ;
* \endcode
*
* If the class is in a namespace, then the macro call should also be
* in the namespace.
*
* Note the closing ';' is not on the same line; this prevents
* Doxygen from spuriously warning that the macro invocation is undocumented.
*/
#define NS_OBJECT_ENSURE_REGISTERED(type) \
static struct X ## type ## RegistrationClass \