Browse Source

[trac747] Add doxygen params

Michal 'vorner' Vaner 14 years ago
parent
commit
af1dbc5024
1 changed files with 4 additions and 1 deletions
  1. 4 1
      src/lib/log/log_formatter.h

+ 4 - 1
src/lib/log/log_formatter.h

@@ -163,6 +163,8 @@ public:
     }
 
     /// \brief String version of arg.
+    ///
+    /// \param arg The text to place into the placeholder.
     Formatter& arg(const std::string& arg) {
         if (logger_) {
             // Note that this method does a replacement and returns the
@@ -182,7 +184,8 @@ public:
 
     /// \brief Exception version of arg.
     ///
-    /// Simply for convenience, so the .what() doesn't have to be typed.
+    /// \param e An exception which the "what()" is extracted an put into the
+    ///     message.
     Formatter& arg(const std::exception& e) {
         if (logger_) {
             return (arg(e.what()));