Browse Source

[3965] Updated description of the state_ field to reference constants.

Marcin Siodelski 9 years ago
parent
commit
6c2e664d58
1 changed files with 3 additions and 0 deletions
  1. 3 0
      src/lib/dhcpsrv/lease.h

+ 3 - 0
src/lib/dhcpsrv/lease.h

@@ -162,6 +162,9 @@ struct Lease {
     /// remains in a single state, but it is possible set multiple states
     /// remains in a single state, but it is possible set multiple states
     /// for a single lease. In this case, multiple bits of this bitfield
     /// for a single lease. In this case, multiple bits of this bitfield
     /// will be set.
     /// will be set.
+    ///
+    /// The defined states are represented by the "STATE_*" constants
+    /// belonging to this class.
     uint32_t state_;
     uint32_t state_;
 
 
     /// @brief Convert Lease to Printable Form
     /// @brief Convert Lease to Printable Form