[313-return-a-list-of-all-reservations-by-subnet-id] Addressed some comments

1 files changed, 16 insertions, 0 deletions

diff --git a/src/lib/dhcpsrv/writable_host_data_source.h b/src/lib/dhcpsrv/writable_host_data_source.h
index 1a398064f3..38a3842517 100644
--- a/src/lib/dhcpsrv/writable_host_data_source.h
+++ b/src/lib/dhcpsrv/writable_host_data_source.h
@@ -59,6 +59,14 @@ public:
 
     /// @brief Returns range of hosts in a DHCPv4 subnet.
     ///
+    /// This method implements paged browsing of host databases. The
+    /// parameters specify a page size, an index in sources and the
+    /// starting host id of the range. If not zero this host id is
+    /// excluded from the returned range. When a source is exhausted
+    /// the index is updated. There is no guarantee about the order
+    /// of returned host reservations, only the sources and
+    /// reservations from the same source are ordered.
+    ///
     /// @param subnet_id Subnet identifier.
     /// @param source_index Index of the source.
     /// @param lower_host_id Host identifier used as lower bound for the
@@ -74,6 +82,14 @@ public:
 
     /// @brief Returns range of hosts in a DHCPv6 subnet.
     ///
+    /// This method implements paged browsing of host databases. The
+    /// parameters specify a page size, an index in sources and the
+    /// starting host id of the range. If not zero this host id is
+    /// excluded from the returned range. When a source is exhausted
+    /// the index is updated. There is no guarantee about the order
+    /// of returned host reservations, only the sources and
+    /// reservations from the same source are ordered.
+    ///
     /// @param subnet_id Subnet identifier.
     /// @param source_index Index of the source.
     /// @param lower_host_id Host identifier used as lower bound for the