mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-22 01:49:48 +00:00
Code Issues Releases Wiki Activity

[#226] Fixed some doxygen errors

Browse Source
This commit is contained in:
Francis Dupont 2025-08-20 19:43:25 +02:00
parent 6754a4b86a
commit f5ef1ab3ac
4 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/lib/asiolink/io_service.cc
View File

@ -69,7 +69,7 @@ public:
/// false this indicates that the IOService was stopped.
///
/// @param wait_time_usecs wait time in microseconds.
/// @param[out] time_out set to true if the wait time expired
/// @param[out] timed_out set to true if the wait time expired
/// without any handlers executing.
/// timed_out parameter will be set true if the wait time elapsed.
///

2
src/lib/asiolink/io_service.h
View File

@ -70,7 +70,7 @@ public:
/// false this indicates that the IOService was stopped.
///
/// @param wait_time_usecs wait time in microseconds.
/// @param[out] time_out set to true if the wait time expired
/// @param[out] timed_out set to true if the wait time expired
/// without any handlers executing.
/// timed_out parameter will be set true if the wait time elapsed.
///

2
src/lib/dhcp/classify.h
View File

@ -272,7 +272,7 @@ private:
/// their hashes are equal, if two class lists are not equal their hashes
/// are almost surely not equal.
///
/// @param address A @c ClientClasses to hash.
/// @param client_classes A @c ClientClasses to hash.
/// @return The hash of the ClientClasses.
size_t hash_value(const ClientClasses& client_classes);

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

@ -816,8 +816,8 @@ public:
///
/// @param ctx client context that passes all necessary information. See
/// @ref ClientContext6 for details.
/// @param [out] preferred set to the preferred lifetime that should be used.
/// @param [out] valid set to the valid lifetime that should be used.
/// @param[out] preferred set to the preferred lifetime that should be used.
/// @param[out] valid set to the valid lifetime that should be used.
static void getLifetimes6(ClientContext6& ctx, uint32_t& preferred,
uint32_t& valid);
@ -830,10 +830,10 @@ public:
///
/// @param ctx client context that passes all necessary information. See
/// @ref ClientContext6 for details.
/// @param [in/out] preferred set to the preferred lifetime that should
// be used. Caller must set it to 0 or remaining value.
/// @param [in/out] valid set to the valid lifetime that should be used.
/// Caller must set it to 0 or remaining value.
/// @param[in,out] preferred set to the preferred lifetime that should
/// be used. Caller must set it to 0 or remaining value.
/// @param[in,out] valid set to the valid lifetime that should be used.
/// Caller must set it to 0 or remaining value.
static void getMinLifetimes6(ClientContext6& ctx, uint32_t& preferred,
uint32_t& valid);
private:
@ -850,7 +850,7 @@ private:
/// available
/// @param prefix_len length of the prefix (for PD only)
/// should be 128 for other lease types
/// @param [out] callout_status callout returned by the lease6_select
/// @param[out] callout_status callout returned by the lease6_select
///
/// The following fields of the ctx structure are used:
/// @ref ClientContext6::subnet_ Subnet the lease is allocated from
@ -1564,9 +1564,8 @@ public:
/// remaining lifetime is returned when greater than minimal.
///
/// @param ctx Client context holding various information about the client.
/// @param [in/out] valid set to the valid lifetime that should be used.
/// Caller must set it to 0 or remaining value.
/// @return unsigned integer value of the valid lifetime to use.
/// @param[in,out] valid set to the valid lifetime that should be used.
/// Caller must set it to 0 or remaining value.
static void getMinValidLft(const ClientContext4& ctx, uint32_t& valid);
/// @brief Returns the offer lifetime based on the v4 context