mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-03 15:35:17 +00:00
Code Issues Releases Wiki Activity

[4320] Fix doxygen errors as a result of the review.

Browse Source
This commit is contained in:
Marcin Siodelski
2016-06-13 11:30:31 +02:00
parent 17e2afb7f3
commit de29ab0fe2
2 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/lib/dhcpsrv/alloc_engine.h
View File

@@ -523,12 +523,13 @@ public:
/// ///
/// The following fields of ClientContext6 are used: /// 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::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/> /// that client sent<br/>
/// @ref ClientContext6::hints_ a hint that the client provided<br/> /// @ref ClientContext6::IAContext::hints_ a hint that the client provided<br/>
/// @ref ClientContext6::type_ lease type (IA, TA or PD)<br/> /// @ref ClientContext6::IAContext::type_ lease type (IA, TA or PD)<br/>
/// @ref ClientContext6::fwd_dns_update_ A boolean value which indicates /// @ref ClientContext6::fwd_dns_update_ A boolean value which indicates
/// that server takes responsibility for the forward DNS Update /// that server takes responsibility for the forward DNS Update
/// for this lease (if true).<br/> /// for this lease (if true).<br/>
@@ -541,7 +542,8 @@ public:
/// allocated (true)<br/> /// allocated (true)<br/>
/// @ref ClientContext6::callout_handle_ a callout handle (used in hooks). A /// @ref ClientContext6::callout_handle_ a callout handle (used in hooks). A
/// lease callouts will be executed if this parameter is passed.<br/> /// 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 /// will append old leases. Leases are stored in the same order as in
/// the collection of new leases, being returned. For newly allocated /// the collection of new leases, being returned. For newly allocated
/// leases (not renewed) the NULL pointers are stored in this /// leases (not renewed) the NULL pointers are stored in this
@@ -569,9 +571,10 @@ public:
/// ///
/// @param ctx Message processing context. It holds various information /// @param ctx Message processing context. It holds various information
/// extracted from the client's message and required to allocate a lease. /// extracted from the client's message and required to allocate a lease.
/// In particular, @ref ClientContext6::hints_ provides list of addresses or /// In particular, @ref ClientContext6::IAContext::hints_ provides list
/// prefixes the client had sent. @ref ClientContext6::old_leases_ will /// of addresses or
/// contain removed leases in this case. /// prefixes the client had sent. @ref ClientContext6::IAContext::old_leases_
/// will contain removed leases in this case.
/// ///
/// @return Returns renewed lease. /// @return Returns renewed lease.
Lease6Collection renewLeases6(ClientContext6& ctx); Lease6Collection renewLeases6(ClientContext6& ctx);

5
src/lib/dhcpsrv/pgsql_connection.h
View File

@@ -203,10 +203,7 @@ public:
/// Creates a prepared statement from the text given and adds it to the /// Creates a prepared statement from the text given and adds it to the
/// statements_ vector at the given index. /// statements_ vector at the given index.
/// ///
/// @param index Index into the statements_ vector into which the text /// @param statement SQL statement to be prepared.
/// should be placed. The vector must be big enough for the index
/// to be valid, else an exception will be thrown.
/// @param text Text of the SQL statement to be prepared.
/// ///
/// @throw isc::dhcp::DbOperationError An operation on the open database has /// @throw isc::dhcp::DbOperationError An operation on the open database has
/// failed. /// failed.