Browse Source

[3988] Documentation updated.

Tomek Mrugalski 9 years ago
parent
commit
125f433f90

+ 2 - 1
src/bin/dhcp4/dhcp4_hooks.dox

@@ -280,7 +280,8 @@ packet processing. Hook points that are not specific to packet processing
   - name: @b lease4, type: isc::dhcp::Lease4Ptr, direction: <b>in</b>
   - name: @b lease4, type: isc::dhcp::Lease4Ptr, direction: <b>in</b>
 
 
 - @b Description: this callout is executed for each declined lease that
 - @b Description: this callout is executed for each declined lease that
-  has expired and is being recovered. The lease has already been stripped
+  has expired (was put aside for the duration of decline-probation-period)
+  and is being recovered. The lease has already been stripped
   from any client identifying information when it was put into declined
   from any client identifying information when it was put into declined
   state. In principle the callouts can modify the lease in this hook,
   state. In principle the callouts can modify the lease in this hook,
   but it makes little sense. There's no useful data in the lease, except
   but it makes little sense. There's no useful data in the lease, except

+ 2 - 1
src/bin/dhcp6/dhcp6_hooks.dox

@@ -294,7 +294,8 @@ packet processing. Hook points that are not specific to packet processing
   - name: @b lease6, type: isc::dhcp::Lease6Ptr, direction: <b>in</b>
   - name: @b lease6, type: isc::dhcp::Lease6Ptr, direction: <b>in</b>
 
 
 - @b Description: this callout is executed for each declined lease that
 - @b Description: this callout is executed for each declined lease that
-  has expired and is being recovered. The lease has already been stripped
+  has expired (was put aside for the duration of decline-probation-period)
+  and is being recovered. The lease has already been stripped
   from any client identifying information when it was put into declined
   from any client identifying information when it was put into declined
   state. In principle the callouts can modify the lease in this hook,
   state. In principle the callouts can modify the lease in this hook,
   but it makes little sense. There's no useful data in the lease, except
   but it makes little sense. There's no useful data in the lease, except

+ 1 - 1
src/lib/hooks/callout_handle.h

@@ -234,7 +234,7 @@ public:
     /// This variable is interrogated by the server to see if the remaining
     /// This variable is interrogated by the server to see if the remaining
     /// callouts associated with the current hook should be bypassed.
     /// callouts associated with the current hook should be bypassed.
     ///
     ///
-    /// @param skip New value of the "skip" flag.
+    /// @param next New value of the next step status.
     void setStatus(const CalloutNextStep next) {
     void setStatus(const CalloutNextStep next) {
         next_step_ = next;
         next_step_ = next;
     }
     }