summaryrefslogtreecommitdiffstats
path: root/src/lib/dhcpsrv/alloc_engine.h
diff options
context:
space:
mode:
authorMarcin Siodelski <marcin@isc.org>2016-06-13 11:30:31 +0200
committerMarcin Siodelski <marcin@isc.org>2016-06-13 11:30:31 +0200
commitde29ab0fe2aafea331e6dc1cd9fdfa489d2056f2 (patch)
treeead32304b3d55a13d358915e22e7d476b0ebfc54 /src/lib/dhcpsrv/alloc_engine.h
parent[4320] Global set of allocated addresses in the ClientContext6. (diff)
downloadkea-de29ab0fe2aafea331e6dc1cd9fdfa489d2056f2.tar.xz
kea-de29ab0fe2aafea331e6dc1cd9fdfa489d2056f2.zip
[4320] Fix doxygen errors as a result of the review.
Diffstat (limited to 'src/lib/dhcpsrv/alloc_engine.h')
-rw-r--r--src/lib/dhcpsrv/alloc_engine.h19
1 files changed, 11 insertions, 8 deletions
diff --git a/src/lib/dhcpsrv/alloc_engine.h b/src/lib/dhcpsrv/alloc_engine.h
index 434a2cf002..69ac652f04 100644
--- a/src/lib/dhcpsrv/alloc_engine.h
+++ b/src/lib/dhcpsrv/alloc_engine.h
@@ -523,12 +523,13 @@ public:
///
/// The following fields of ClientContext6 are used:
///
- /// @ref ClientContext6::subnet_ subnet the allocation should come from<br/>
+ /// @ref ClientContext6::subnet_ subnet the allocation should
+ /// come from<br/>
/// @ref ClientContext6::duid_ Client's DUID<br/>
- /// @ref ClientContext6::iaid_ iaid field from the IA_NA container
+ /// @ref ClientContext6::IAContext::iaid_ iaid field from the IA_NA container
/// that client sent<br/>
- /// @ref ClientContext6::hints_ a hint that the client provided<br/>
- /// @ref ClientContext6::type_ lease type (IA, TA or PD)<br/>
+ /// @ref ClientContext6::IAContext::hints_ a hint that the client provided<br/>
+ /// @ref ClientContext6::IAContext::type_ lease type (IA, TA or PD)<br/>
/// @ref ClientContext6::fwd_dns_update_ A boolean value which indicates
/// that server takes responsibility for the forward DNS Update
/// for this lease (if true).<br/>
@@ -541,7 +542,8 @@ public:
/// allocated (true)<br/>
/// @ref ClientContext6::callout_handle_ a callout handle (used in hooks). A
/// lease callouts will be executed if this parameter is passed.<br/>
- /// @ref ClientContext6::old_leases_ [out] Collection to which this function
+ /// @ref ClientContext6::IAContext::old_leases_ [out] Collection to which this
+ /// function
/// will append old leases. Leases are stored in the same order as in
/// the collection of new leases, being returned. For newly allocated
/// leases (not renewed) the NULL pointers are stored in this
@@ -569,9 +571,10 @@ public:
///
/// @param ctx Message processing context. It holds various information
/// extracted from the client's message and required to allocate a lease.
- /// In particular, @ref ClientContext6::hints_ provides list of addresses or
- /// prefixes the client had sent. @ref ClientContext6::old_leases_ will
- /// contain removed leases in this case.
+ /// In particular, @ref ClientContext6::IAContext::hints_ provides list
+ /// of addresses or
+ /// prefixes the client had sent. @ref ClientContext6::IAContext::old_leases_
+ /// will contain removed leases in this case.
///
/// @return Returns renewed lease.
Lease6Collection renewLeases6(ClientContext6& ctx);