Commit 8b1a0145 authored by Marcin Siodelski's avatar Marcin Siodelski
Browse files

[2545] Cleanup some doxygen errors.

parent 19bd1a5a
......@@ -28,7 +28,7 @@ namespace dhcp {
class Dhcpv6Srv;
/// An exception that is thrown if an error occurs while configuring an
/// \c Dhcpv6Srv object.
/// @c Dhcpv6Srv object.
class Dhcp6ConfigError : public isc::Exception {
public:
......@@ -54,9 +54,10 @@ public:
/// 2 - commit failed (parsing was successful, but the values could not be
/// stored in the configuration).
///
/// @param config_set a new configuration for DHCPv6 server
/// @return answer that contains result of the reconfiguration
/// @throw Dhcp6ConfigError if trying to create a parser for NULL config
/// @param server DHCPv6 server object.
/// @param config_set a new configuration for DHCPv6 server.
/// @return answer that contains result of the reconfiguration.
/// @throw Dhcp6ConfigError if trying to create a parser for NULL config.
isc::data::ConstElementPtr
configureDhcp6Server(Dhcpv6Srv& server, isc::data::ConstElementPtr config_set);
......
......@@ -35,19 +35,19 @@
This method iterates over list of received configuration elements and creates a
list of parsers for each received entry. Parser is an object that is derived
from a \ref isc::dhcp::DhcpConfigParser class. Once a parser is created
from a DhcpConfigParser class. Once a parser is created
(constructor), its value is set (using build() method). Once all parsers are
build, the configuration is then applied ("commited") and commit() method is
called.
All parsers are defined in src/bin/dhcp6/config_parser.cc file. Some of them
are generic (e.g. \ref isc::dhcp::Uint32Parser that is able to handle any
unsigned 32 bit integer), but some are very specialized (e.g. \ref
isc::dhcp::Subnets6ListConfigParser parses definitions of Subnet6 lists). In
some cases, e.g. subnet6 definitions, the configuration entry is not a simple
value, but a map or a list itself. In such case, the parser iterates over all
elements and creates parsers for a given scope. This process may be repeated
(sort of) recursively.
are generic (e.g. Uint32Parser that is able to handle any
unsigned 32 bit integer), but some are very specialized (e.g.
Subnets6ListConfigParser parses definitions of Subnet6 lists). In some cases,
e.g. subnet6 definitions, the configuration entry is not a simple value, but
a map or a list itself. In such case, the parser iterates over all elements
and creates parsers for a given scope. This process may be repeated (sort of)
recursively.
@section dhcpv6ConfigInherit DHCPv6 Configuration Inheritance
......@@ -55,16 +55,16 @@
For example, renew-timer value may be specified at a global scope and it then
applies to all subnets. However, some subnets may have it overwritten with more
specific values that takes precedence over global values that are considered
defaults. Some parsers (e.g. \ref isc::dhcp::Uint32Parser and \ref
isc::dhcp::StringParser) implement that inheritance. By default, they store
values in global uint32_defaults and string_defaults storages. However, it is
possible to instruct them to store parsed values in more specific
storages. That capability is used, e.g. in \ref isc::dhcp::Subnet6ConfigParser
that has its own storage that is unique for each subnet. Finally, during commit
phase (commit() method), appropriate parsers can use apply parameter inheritance.
defaults. Some parsers (e.g. Uint32Parser and StringParser) implement that
inheritance. By default, they store values in global uint32_defaults and
string_defaults storages. However, it is possible to instruct them to store
parsed values in more specific storages. That capability is used, e.g. in
Subnet6ConfigParser that has its own storage that is unique for each subnet.
Finally, during commit phase (commit() method), appropriate parsers can use
apply parameter inheritance.
Debugging configuration parser may be confusing. Therefore there is a special
class called \ref isc::dhcp::DebugParser. It does not configure anything, but just
class called DebugParser. It does not configure anything, but just
accepts any parameter of any type. If requested to commit configuration, it will
print out received parameter name and its value. This class is not currently used,
but it is convenient to have it every time a new parameter is added to DHCP
......
......@@ -361,7 +361,7 @@ public:
/// @brief Factory function to create option with array of integer values.
///
/// @param universe (V4 or V6).
/// @param u universe (V4 or V6).
/// @param type option type.
/// @param begin iterator pointing to the beginning of the buffer.
/// @param end iterator pointing to the end of the buffer.
......
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