Utils/Logger: Completed documentation

[senf.git] / Utils / Logger / StringTarget.hh

diff --git a/Utils/Logger/StringTarget.hh b/Utils/Logger/StringTarget.hh
index 6aa740b..1981d74 100644 (file)
--- a/Utils/Logger/StringTarget.hh
+++ b/Utils/Logger/StringTarget.hh
@@ -37,6 +37,10 @@ namespace senf {
 namespace log {
   
     /** \brief Store log messages in a string buffer
+
+        This target is mostly useful for debug purposes. 
+
+        \ingroup targets
       */
     class StringTarget 
         : private boost::base_from_member<std::stringstream>,
@@ -56,8 +60,8 @@ namespace log {
         ///@}
         ///////////////////////////////////////////////////////////////////////////
 
-        std::string str() const;
-        void clear();
+        std::string str() const;        ///< Get log messages accumulated so far
+        void clear();                   ///< Clear buffer
 
     protected: