diff --git a/doc/doxygen.conf b/doc/doxygen.conf index 5b9588622..ebc874d59 100644 --- a/doc/doxygen.conf +++ b/doc/doxygen.conf @@ -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. diff --git a/src/core/model/log.h b/src/core/model/log.h index bfb2b3e27..c5b22a838 100644 --- a/src/core/model/log.h +++ b/src/core/model/log.h @@ -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) \ diff --git a/src/core/model/object-base.h b/src/core/model/object-base.h index 83a00a615..54bf8f72a 100644 --- a/src/core/model/object-base.h +++ b/src/core/model/object-base.h @@ -26,23 +26,14 @@ #include /** + * \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 \