From: Francis Dupont <fdupont@isc.org>
Date: Wed, 8 Jul 2015 20:00:30 +0000 (+0200)
Subject: [3752] Improved logging comments
X-Git-Tag: trac3911a_base~2^2~6
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=090185a1d0dff9c6b4be1f425c71e52c548ae87f;p=thirdparty%2Fkea.git

[3752] Improved logging comments
---

diff --git a/src/lib/dhcpsrv/logging.h b/src/lib/dhcpsrv/logging.h
index 50fdc7f538..dc950f1f77 100644
--- a/src/lib/dhcpsrv/logging.h
+++ b/src/lib/dhcpsrv/logging.h
@@ -34,7 +34,8 @@ namespace dhcp {
 ///         {
 ///             "output": "/home/thomson/kea-inst/kea-warn.log",
 ///             "maxver": 8,
-///             "maxsize": 204800
+///             "maxsize": 204800,
+///             "flush": true
 ///         }
 ///     ],
 ///     "severity": "WARN"
@@ -74,16 +75,8 @@ private:
 
     /// @brief Parses output_options structure
     ///
-    /// An example data structure that holds output_options in JSON format
-    /// looks like this:
-    ///     "output_options": [
-    ///         {
-    ///             "output": "/var/log/kea-warn.log",
-    ///             "maxver": 8,
-    ///             "maxsize": 204800,
-    ///             "flush": ture
-    ///         }
-    ///     ],
+    /// @ref @c LogConfigParser for an example in JSON format.
+    ///
     /// @param destination parsed parameters will be stored here
     /// @param output_options element to be parsed
     void parseOutputOptions(std::vector<LoggingDestination>& destination,