mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-30 21:45:37 +00:00
Code Issues Releases Wiki Activity

[3180] Fixed doxygen errors in OptionDefinition.

Browse Source
This commit is contained in:
Marcin Siodelski
2013-10-07 10:56:03 +02:00
parent b054ce924f
commit 0fcc98b098
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/lib/dhcp/option_definition.h
View File

@@ -310,6 +310,10 @@ public:
/// @param type option type.
/// @param begin beginning of the option buffer.
/// @param end end of the option buffer.
/// @param callback An instance of the function which parses packet options.
/// If this is set to non NULL value this function will be used instead of
/// @c isc::dhcp::LibDHCP::unpackOptions6 and
/// isc::dhcp::LibDHCP::unpackOptions4.
///
/// @return instance of the DHCP option.
/// @throw InvalidOptionValue if data for the option is invalid.
@@ -331,6 +335,10 @@ public:
/// @param u option universe (V4 or V6).
/// @param type option type.
/// @param buf option buffer.
/// @param callback An instance of the function which parses packet options.
/// If this is set to non NULL value this function will be used instead of
/// @c isc::dhcp::LibDHCP::unpackOptions6 and
/// isc::dhcp::LibDHCP::unpackOptions4.
///
/// @return instance of the DHCP option.
/// @throw InvalidOptionValue if data for the option is invalid.
@@ -439,8 +447,15 @@ public:
///
/// @param u universe (V4 or V6).
/// @param type option type.
/// @param encapsulated_space An option space being encapsulated by the
/// options created by this factory function. The options which belong to
/// encapsulated option space are sub options of this option.
/// @param begin iterator pointing to the beginning of the buffer.
/// @param end iterator pointing to the end of the buffer.
/// @param callback An instance of the function which parses packet options.
/// If this is set to non NULL value this function will be used instead of
/// @c isc::dhcp::LibDHCP::unpackOptions6 and
/// isc::dhcp::LibDHCP::unpackOptions4.
/// @tparam T type of the data field (must be one of the uintX_t or intX_t).
///
/// @throw isc::OutOfRange if provided option buffer length is invalid.