From: Francis Dupont <fdupont@isc.org>
Date: Sun, 5 Apr 2020 07:44:42 +0000 (+0200)
Subject: [#816] Made getObservation usable to check existence
X-Git-Tag: Kea-1.7.7~18
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f776e6b807e8e67e6b18006cda52ae6f7c8c1953;p=thirdparty%2Fkea.git

[#816] Made getObservation usable to check existence
---

diff --git a/src/lib/stats/stats_mgr.h b/src/lib/stats/stats_mgr.h
index 66f1c89c2b..49ab17ca7e 100644
--- a/src/lib/stats/stats_mgr.h
+++ b/src/lib/stats/stats_mgr.h
@@ -246,7 +246,8 @@ public:
 
     /// @brief Returns an observation.
     ///
-    /// Used in testing only. Production code should use @ref get() method.
+    /// Used in testing only. Production code should use @ref get() method
+    /// when the value is dereferenced.
     /// Calls @ref getObservationInternal() method in a thread safe context.
     ///
     /// @param name name of the statistic
@@ -255,8 +256,8 @@ public:
 
     /// @brief Returns an observation in a thread safe context.
     ///
-    /// Used in testing only. Production code should use @ref get() method.
-    /// Should be called in a thread safe context.
+    /// Used in testing only. Production code should use @ref get() method
+    /// when the value is dereferenced. Should be called in a thread safe context.
     ///
     /// @param name name of the statistic
     /// @return Pointer to the Observation object