]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[5651] Updated a comment in the lease_cmds.
authorMarcin Siodelski <marcin@isc.org>
Thu, 28 Jun 2018 12:23:16 +0000 (14:23 +0200)
committerMarcin Siodelski <marcin@isc.org>
Thu, 28 Jun 2018 12:23:16 +0000 (14:23 +0200)
As a result of the review.

src/hooks/dhcp/lease_cmds/lease_cmds.cc

index 4d24546df9b2bf2f2ffe4bc1ce521a0e402f7962..59face144b8fcec92e485a51b66243e8441a64ef 100644 (file)
@@ -146,13 +146,13 @@ public:
 
     /// @brief lease4-get-page, lease6-get-page commands handler
     ///
-    /// These commands attempt to retrieve 1 page of all IPv4 or IPv6
-    /// leases. The size of the page is specified by the caller. The
-    /// caller also specifies the last address returned in the previous
-    /// page. The new page starts from the first address following the
-    /// address specified by the caller. If the first page should be
-    /// returned the IPv4 zero address, IPv6 zero address or the keyword
-    /// "begin" should be provided instead of the last address.
+    /// These commands attempt to retrieve 1 page of leases. The maximum size
+    /// of the page is specified by the caller. The caller also specifies
+    /// the last address returned in the previous page. The new page
+    /// starts from the first address following the address specified by
+    /// the caller. If the first page should be returned the IPv4
+    /// zero address, IPv6 zero address or the keyword "start" should
+    /// be provided instead of the last address.
     ///
     /// @param handle Callout context - which is expected to contain the
     /// get commands JSON text in the "command" argument.