diff --git a/doc/doxygen.conf b/doc/doxygen.conf index 6f3f7e2bb..dc852eb9f 100644 --- a/doc/doxygen.conf +++ b/doc/doxygen.conf @@ -1002,7 +1002,7 @@ INCLUDE_FILE_PATTERNS = # undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = RUN_SELF_TESTS NS3_DEBUG_ENABLE NS3_ASSERT_ENABLE +PREDEFINED = RUN_SELF_TESTS NS3_DEBUG_ENABLE NS3_ASSERT_ENABLE NS3_LOG_ENABLE # 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/log.h b/src/core/log.h index c027fa022..d4cf9542e 100644 --- a/src/core/log.h +++ b/src/core/log.h @@ -88,6 +88,19 @@ #ifdef NS3_LOG_ENABLE +/** + * \param level the log level + * \param msg the message to log + * + * This macro allows you to log an arbitrary message at a specific + * log level. The log message is expected to be a C++ ostream + * message such as "my string" << aNumber << "my oth stream". + * + * Typical usage looks like: + * \code + * NS_LOG (LOG_DEBUG, "a number="<