[5469] Corrections in doxygen for lease_cmds.

diff --git a/src/hooks/dhcp/lease_cmds/lease_cmds.h b/src/hooks/dhcp/lease_cmds/lease_cmds.h
index 05450f0f136162fd58fd21c7c2dd75d45dc4b5bc..cb1515ada224602fcb5c103fc03171b5d224a89f 100644 (file)
--- a/src/hooks/dhcp/lease_cmds/lease_cmds.h
+++ b/src/hooks/dhcp/lease_cmds/lease_cmds.h
@@ -127,7 +127,8 @@ public:
     ///
     /// @param handle Callout context - which is expected to contain the
     /// get command JSON text in the "command" argument
-    /// @return result of the operation (includes lease details, if found)
+    /// @return result of the operation (includes lease details, if found),
+    /// 1 if an error occurs, 3 if lease not found.
     int
     leaseGetHandler(hooks::CalloutHandle& handle);
 
@@ -153,7 +154,8 @@ public:
     ///
     /// @param handle Callout context - which is expected to contain the
     /// get command JSON text in the "command" argument
-    /// @return result of the operation.
+    /// @return 0 if the handler has been invoked successfully, 1 if an
+    /// error occurs, 3 if no leases are returned.
     int
     leaseGetAllHandler(hooks::CalloutHandle& handle);
 

diff --git a/src/hooks/dhcp/lease_cmds/lease_cmds_callouts.cc b/src/hooks/dhcp/lease_cmds/lease_cmds_callouts.cc
index 2853ba55cefa18105491deb0cf5a3e84f4158d41..8c18da45e8951dcb9020f23f3a608ae03ffc81ee 100644 (file)
--- a/src/hooks/dhcp/lease_cmds/lease_cmds_callouts.cc
+++ b/src/hooks/dhcp/lease_cmds/lease_cmds_callouts.cc
@@ -69,7 +69,7 @@ int lease6_get(CalloutHandle& handle) {
 /// @param handle Callout handle used to retrieve a command and
 /// provide a response.
 /// @return 0 if this callout has been invoked successfully,
-/// 1 if an error occurs, 2 if empty.
+/// 1 if an error occurs, 3 if no leases are returned.
 int lease4_get_all(CalloutHandle& handle) {
     LeaseCmds lease_cmds;
     return (lease_cmds.leaseGetAllHandler(handle));
@@ -80,7 +80,7 @@ int lease4_get_all(CalloutHandle& handle) {
 /// @param handle Callout handle used to retrieve a command and
 /// provide a response.
 /// @return 0 if this callout has been invoked successfully,
-/// 1 if an error occurs, 2 if empty.
+/// 1 if an error occurs, 3 if no leases are returned.
 int lease6_get_all(CalloutHandle& handle) {
     LeaseCmds lease_cmds;
     return (lease_cmds.leaseGetAllHandler(handle));