Commit 974cc56e authored by Tomek Mrugalski's avatar Tomek Mrugalski 🛰
Browse files

[3709] Doc updated

parent 9c8ff76f
......@@ -584,22 +584,22 @@ protected:
///
/// The following fields of @ref ClientContext4 are used:
///
/// @ref ClientContext4::subnet_ subnet the allocation should come from
/// @ref ClientContext4::clientid_ Client identifier
/// @ref ClientContext4::hwaddr_ Client's hardware address info
/// @ref ClientContext4::requested_address_ A hint that the client provided
/// @ref ClientContext4::fwd_dns_update_ Indicates whether forward DNS
/// - @ref ClientContext4::subnet_ subnet the allocation should come from
/// - @ref ClientContext4::clientid_ Client identifier
/// - @ref ClientContext4::hwaddr_ Client's hardware address info
/// - @ref ClientContext4::requested_address_ A hint that the client provided
/// - @ref ClientContext4::fwd_dns_update_ Indicates whether forward DNS
/// update will be performed for the client (true) or not (false).
/// @ref ClientContext4::rev_dns_update_ Indicates whether reverse DNS
/// - @ref ClientContext4::rev_dns_update_ Indicates whether reverse DNS
/// update will be performed for the client (true) or not (false).
/// @ref ClientContext4::hostname_ A string carrying hostname to be used for
/// - @ref ClientContext4::hostname_ A string carrying hostname to be used for
/// DNS updates.
/// @ref ClientContext4::fake_allocation_ Is this real i.e. REQUEST (false)
/// - @ref ClientContext4::fake_allocation_ Is this real i.e. REQUEST (false)
/// or just picking an address for DISCOVER that is not really
/// allocated (true)
/// @ref ClientContext4::callout_handle_ A callout handle (used in hooks).
/// - @ref ClientContext4::callout_handle_ A callout handle (used in hooks).
/// A lease callouts will be executed if this parameter is passed.
/// @ref ClientContext4::old_lease_ [out] Holds the pointer to a previous
/// - @ref ClientContext4::old_lease_ [out] Holds the pointer to a previous
/// instance of a lease. The NULL pointer indicates that lease didn't
/// exist prior to calling this function (e.g. new lease has been allocated).
///
......@@ -671,32 +671,32 @@ protected:
///
/// The following fields of ClientContext6 are used:
///
/// @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
/// 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::fwd_dns_update_ A boolean value which indicates
/// - @ref ClientContext6::subnet_ subnet the allocation should come from
/// - @ref ClientContext6::duid_ Client's DUID
/// - @ref ClientContext6::iaid_ iaid field from the IA_NA container
/// that client sent
/// - @ref ClientContext6::hints_ a hint that the client provided
/// - @ref ClientContext6::type_ lease type (IA, TA or PD)
/// - @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/>
/// @ref ClientContext6::rev_dns_update_ A boolean value which indicates
/// for this lease (if true).
/// - @ref ClientContext6::rev_dns_update_ A boolean value which indicates
/// that server takes responsibility for the reverse DNS Update for
/// this lease (if true).<br/>
/// @ref ClientContext6::hostname_ A fully qualified domain-name of the client.<br/>
/// @ref ClientContext6::fake_allocation_ is this real i.e. REQUEST (false)
/// this lease (if true).
/// - @ref ClientContext6::hostname_ A fully qualified domain-name of the client.
/// - @ref ClientContext6::fake_allocation_ is this real i.e. REQUEST (false)
/// or just picking an address for SOLICIT that is not really
/// 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
/// allocated (true)
/// - @ref ClientContext6::callout_handle_ a callout handle (used in hooks).
/// Lease callouts will be executed if this parameter is passed.
/// - @ref ClientContext6::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
/// collection as old leases.<br/>
/// @ref ClientContext6::hwaddr_ Hardware address (optional, may be null if
/// not available)<br/>
/// @ref ClientContext6::host_ Host reservation. allocateLeases6 will set
/// collection as old leases.
/// - @ref ClientContext6::hwaddr_ Hardware address (optional, may be null if
/// not available)
/// - @ref ClientContext6::host_ Host reservation. allocateLeases6 will set
/// this field, if appropriate reservation is found.
///
/// @return Allocated IPv6 leases (may be empty if allocation failed)
......@@ -745,19 +745,19 @@ private:
/// @param ctx client context that contains additional parameters.
///
/// In particular, the following fields from Client context are used:
/// @ref ClientContext4::subnet_ Subnet the lease is allocated from
/// @ref ClientContext4::clientid_ Client identifier
/// @ref ClientContext4::hwaddr_ Client's hardware address
/// @ref ClientContext4::fwd_dns_update_ Indicates whether forward DNS update
/// - @ref ClientContext4::subnet_ Subnet the lease is allocated from
/// - @ref ClientContext4::clientid_ Client identifier
/// - @ref ClientContext4::hwaddr_ Client's hardware address
/// - @ref ClientContext4::fwd_dns_update_ Indicates whether forward DNS update
/// will be performed for the client (true) or not (false).
/// @ref ClientContext4::rev_dns_update_ Indicates whether reverse DNS update
/// - @ref ClientContext4::rev_dns_update_ Indicates whether reverse DNS update
/// will be performed for the client (true) or not (false).
/// @ref ClientContext4::hostname_ A string carrying hostname to be used for
/// - @ref ClientContext4::hostname_ A string carrying hostname to be used for
/// DNS updates.
/// @ref ClientContext4::callout_handle_ a callout handle (used in hooks).
/// - @ref ClientContext4::callout_handle_ a callout handle (used in hooks).
/// A lease callouts will be executed if this parameter is passed
/// (and there are callouts registered)
/// @ref ClientContext4::fake_allocation_ Is this real i.e. REQUEST (false)
/// - @ref ClientContext4::fake_allocation_ Is this real i.e. REQUEST (false)
/// or just picking an address for DISCOVER that is not really
/// allocated (true)
/// @return allocated lease (or NULL in the unlikely case of the lease just
......@@ -798,23 +798,23 @@ private:
/// should be 128 for other lease types
///
/// The following fields of the ctx structure are used:
/// @ref ClientContext6::subnet_ subnet the lease is allocated from
/// @ref ClientContext6::duid_ client's DUID
/// @ref ClientContext6::iaid_ IAID from the IA_NA container the client sent to us
/// @ref ClientContext6::type_ lease type (IA, TA or PD)
/// @ref ClientContext6::fwd_dns_update_ A boolean value which indicates that server takes
/// responsibility for the forward DNS Update for this lease
/// - @ref ClientContext6::subnet_ subnet the lease is allocated from
/// - @ref ClientContext6::duid_ client's DUID
/// - @ref ClientContext6::iaid_ IAID from the IA_NA container the client sent to us
/// - @ref ClientContext6::type_ lease type (IA, TA or PD)
/// - @ref ClientContext6::fwd_dns_update_ A boolean value which indicates that
/// server takes responsibility for the forward DNS Update for this lease
/// (if true).
/// @ref ClientContext6::rev_dns_update_ A boolean value which indicates that server takes
/// responsibility for the reverse DNS Update for this lease
/// - @ref ClientContext6::rev_dns_update_ A boolean value which indicates that
/// server takes responsibility for the reverse DNS Update for this lease
/// (if true).
/// @ref ClientContext6::hostname_ A fully qualified domain-name of the client.
/// @ref ClientContext6::hwaddr_ Hardware address (optional, may be null for Lease6)
/// @ref ClientContext6::callout_handle_ a callout handle (used in hooks). A lease callouts
/// will be executed if this parameter is passed (and there are callouts
/// registered)
/// @ref ClientContext6::fake_allocation_ is this real i.e. REQUEST (false) or just picking
/// an address for SOLICIT that is not really allocated (true)
/// - @ref ClientContext6::hostname_ A fully qualified domain-name of the client.
/// - @ref ClientContext6::hwaddr_ Hardware address (optional, may be null for Lease6)
/// - @ref ClientContext6::callout_handle_ a callout handle (used in hooks). A
/// lease callouts will be executed if this parameter is passed (and there
/// are callouts registered)
/// - @ref ClientContext6::fake_allocation_ is this real i.e. REQUEST (false) or
/// just picking an address for SOLICIT that is not really allocated (true)
/// @return allocated lease (or NULL in the unlikely case of the lease just
/// became unavailable)
Lease6Ptr createLease6(ClientContext6& ctx,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment