[#1247] Improved revision id comments

diff --git a/src/lib/database/audit_entry.h b/src/lib/database/audit_entry.h
index b9466e356b2f29d8f48314fad4dd259a59502700..6c4617577913c133b2dddbbb6a075b31188c8e76 100644 (file)
--- a/src/lib/database/audit_entry.h
+++ b/src/lib/database/audit_entry.h
@@ -178,7 +178,10 @@ public:
         return (modification_time_);
     }
 
-    /// @brief Returns revision id aka modification id.
+    /// @brief Returns revision id.
+    ///
+    /// The revision id is used when two audit entries have the same
+    /// modification time.
     ///
     /// @return Identifier of the revision.
     uint64_t getRevisionId() const {
@@ -212,7 +215,10 @@ private:
     /// @brief Modification time.
     boost::posix_time::ptime modification_time_;
 
-    /// @brief Revision id aka modification id.
+    /// @brief Revision id.
+    ///
+    /// The revision id is used when two audit entries have the same
+    /// modification time.
     uint64_t revision_id_;
 
     /// @brief Log message.