diff --git a/doc/additionalDoc/package.h b/doc/additionalDoc/package.h index e169f7709f0e1135010fa57842194710d5cecb47..88a6dd1af0bdfcc45a07c8edc3df7ab364eee3bd 100644 --- a/doc/additionalDoc/package.h +++ b/doc/additionalDoc/package.h @@ -190,6 +190,8 @@ IEEE Trans. on Robotics, 23(1):60-72, February 2007 \namespace dynamicgraph This is the namespace where every object and class of this library is located. +\defgroup debug Debugging + \defgroup dgraph Core classes and objects @{ diff --git a/include/dynamic-graph/logger.h b/include/dynamic-graph/logger.h index 58e381b6ccabf6b6df6c423e8b8f6b4066e0cf78..98e7e1dc8eaced4e4653480aa6ebfe6e917960c0 100644 --- a/include/dynamic-graph/logger.h +++ b/include/dynamic-graph/logger.h @@ -129,8 +129,32 @@ namespace dynamicgraph { VERBOSITY_NONE }; - /** A simple class for logging messages - */ + /// \ingroup debug + /// + /// \brief Class for logging messages + /// + /// It is intended to be used like this: + /// \code + /// #define ENABLE_RT_LOG + /// #include <dynamic-graph/real-time-logger.h> + /// + /// // Somewhere in the main function of your executable + /// int main (int argc, char** argv) { + /// std::ofstream of; + /// of.open("/tmp/dg-LOGS.txt",std::ofstream::out|std::ofstream::app); + /// dgADD_OSTREAM_TO_RTLOG (of); + /// } + /// + /// // Somewhere in your library + /// dynamicgraph::LoggerVerbosity aLoggerVerbosityLevel = VERBOSITY_WARNING_ERROR; + /// entity.setLoggerVerbosityLevel(aLoggerVerbosityLevel); + /// ... + /// std::string aMsg=aBaseMsg+" WARNING"; + /// entity.sendMsg(aMsg,dynamicgraph::MSG_TYPE_WARNING, __FILE__,__LINE__); + /// + /// \endcode + /// + /// class Logger { public: