small documentation fixes
[senf.git] / Utils / Logger / StringTarget.hh
index 6aa740b..c9591de 100644 (file)
@@ -1,8 +1,8 @@
 // $Id$
 //
 // Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer NETwork research (NET)
+// Fraunhofer Institute for Open Communication Systems (FOKUS) 
+// Competence Center NETwork research (NET), St. Augustin, GERMANY 
 //     Stefan Bund <g0dil@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
 namespace senf {
 namespace log {
   
-    /** \brief Store log messages in a string buffer
+    /** \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: