Commit 9434feda authored by Olivier Stasse's avatar Olivier Stasse Committed by olivier stasse
Browse files

[doc] Add Logger documentation

parent 5076c5c0
...@@ -190,6 +190,8 @@ IEEE Trans. on Robotics, 23(1):60-72, February 2007 ...@@ -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. \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 \defgroup dgraph Core classes and objects
@{ @{
......
...@@ -129,8 +129,32 @@ namespace dynamicgraph { ...@@ -129,8 +129,32 @@ namespace dynamicgraph {
VERBOSITY_NONE 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 class Logger
{ {
public: public:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment