From 9434feda834879ab267524ac40e1955050476181 Mon Sep 17 00:00:00 2001
From: Olivier Stasse <ostasse@laas.fr>
Date: Tue, 29 Jan 2019 17:10:18 +0100
Subject: [PATCH] [doc] Add Logger documentation
---
doc/additionalDoc/package.h | 2 ++
include/dynamic-graph/logger.h | 28 ++++++++++++++++++++++++++--
2 files changed, 28 insertions(+), 2 deletions(-)
diff --git a/doc/additionalDoc/package.h b/doc/additionalDoc/package.h
index e169f77..88a6dd1 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 58e381b..98e7e1d 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:
--
GitLab