Commit f3b332ca authored by Francis Dupont's avatar Francis Dupont
Browse files

[898-add-a-new-hook-to-support-bootp] Some doxygen fixes

parent 3e528a24
...@@ -89,7 +89,7 @@ int pkt4_receive(CalloutHandle& handle) { ...@@ -89,7 +89,7 @@ int pkt4_receive(CalloutHandle& handle) {
/// ///
/// @param handle library handle (unused). /// @param handle library handle (unused).
/// @return always 0. /// @return always 0.
int load(LibraryHandle& /*handle*/) { int load(LibraryHandle& /* handle */) {
LOG_INFO(bootp_logger, BOOTP_LOAD); LOG_INFO(bootp_logger, BOOTP_LOAD);
return (0); return (0);
} }
......
...@@ -83,11 +83,11 @@ The sole parameter is a options list of options with: ...@@ -83,11 +83,11 @@ The sole parameter is a options list of options with:
the query packet. If the option does not already exist in the response the query packet. If the option does not already exist in the response
packet and the expression evaluates to a not empty value, the option packet and the expression evaluates to a not empty value, the option
with the value is added to the response. with the value is added to the response.
- @supersede - Specifies the supersede action: it takes a string expression - @b supersede - Specifies the supersede action: it takes a string expression
on the query packet. If the expression evaluates to a not empty value, on the query packet. If the expression evaluates to a not empty value,
the option with the value is added to the response. If it already exists the option with the value is added to the response. If it already exists
it is overwritten. it is overwritten.
- @remove - Specifies the remove action: it takes a boolean expression - @b remove - Specifies the remove action: it takes a boolean expression
on the query packet. If the expression evaluates to true and the option on the query packet. If the expression evaluates to true and the option
already exists in the response packet, the option is removed from the already exists in the response packet, the option is removed from the
response. Only one action can be specified. response. Only one action can be specified.
...@@ -108,7 +108,7 @@ all located in flex_option_callouts.cc. ...@@ -108,7 +108,7 @@ all located in flex_option_callouts.cc.
kea-dhcp4 server calls @ref pkt4_send (and kea-dhcp6 @ref pkt6_send) with kea-dhcp4 server calls @ref pkt4_send (and kea-dhcp6 @ref pkt6_send) with
the query and response packets. For each configured option the action is the query and response packets. For each configured option the action is
applied by the template @ref process located in flex_option.h. When applied by the template @c process located in flex_option.h. When
required the expression is evaluated on the query packet and the result required the expression is evaluated on the query packet and the result
is used by the action for instance to add a new option. is used by the action for instance to add a new option.
......
...@@ -45,7 +45,7 @@ public: ...@@ -45,7 +45,7 @@ public:
public: public:
/// @brief Constructor. /// @brief Constructor.
/// ///
/// @param option code. /// @param code the option code.
OptionConfig(uint16_t code); OptionConfig(uint16_t code);
/// @brief Destructor. /// @brief Destructor.
......
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