Commit 4410b04b authored by Marcin Siodelski's avatar Marcin Siodelski

[3484] Fixed quite a few doxygen warnings.

parent 731d14b8
......@@ -37,7 +37,7 @@ src/lib/dhcpsrv/parsers/ directory. Parsers specific to the DHCPv4 component
are located in the src/bin/dhcp4/json_config_parser.cc. These parsers derive
from the common configuration parsers and customize their behavior. For
example: the @c Subnet4ConfigParser is used to parse parameters
describing a single subnet. It derives from the @ref
describing a single subnet. It derives from the @c
isc::dhcp::SubnetConfigParser, which implements the common base for both
DHCPv4 and DHCPv6 subnets. The @ref isc::dhcp::Subnet4ConfigParser
implements the @c initSubnet abstract method, which creates an instance of
......
......@@ -156,9 +156,6 @@ typedef boost::shared_ptr<Dhcpv4Exchange> Dhcpv4ExchangePtr;
/// This class does not support any controlling mechanisms directly.
/// See the derived \ref ControlledDhcpv4Srv class for support for
/// command and configuration updates over msgq.
///
/// For detailed explanation or relations between main(), ControlledDhcpv4Srv,
/// Dhcpv4Srv and other classes, see \ref dhcpv4Session.
class Dhcpv4Srv : public Daemon {
public:
......
......@@ -33,9 +33,6 @@ using namespace std;
/// instantiates ControlledDhcpv4Srv class that is responsible for establishing
/// connection with msgq (receiving commands and configuration) and also
/// creating Dhcpv4 server object as well.
///
/// For detailed explanation or relations between main(), ControlledDhcpv4Srv,
/// Dhcpv4Srv and other classes, see \ref dhcpv4Session.
namespace {
......
......@@ -37,7 +37,7 @@ src/lib/dhcpsrv/parsers/ directory. Parsers specific to the DHCPv6 component
are located in the src/bin/dhcp6/json_config_parser.cc. These parsers derive
from the common configuration parsers and customize their behavior. For
example: the @c Subnet6ConfigParser is used to parse parameters
describing a single subnet. It derives from the @ref
describing a single subnet. It derives from the @c
isc::dhcp::SubnetConfigParser, which implements the common base for both
DHCPv4 and DHCPv6 subnets. The @ref isc::dhcp::Subnet6ConfigParser
implements the @c initSubnet abstract method, which creates an instance of
......
......@@ -331,8 +331,6 @@ protected:
/// not appropriate for the link the client is attached to, the server MAY
/// send the IA with address lifetimes set to 0 or discard the message.
///
/// @param subnet subnet the sender belongs to
/// @param duid client's duid
/// @param query client's message (Renew or Rebind)
/// @param answer server's response to the client's message. This
/// message should contain Client FQDN option being sent by the server
......
......@@ -349,13 +349,7 @@ public:
/// \brief Checks if the data received is complete.
///
/// \param staging Unused
/// \param length Unused
/// \param cumulative Unused
/// \param offset Unused.
/// \param expected Unused.
/// \param outbuff Unused.
///
/// The parameters are unused.
/// \return Always true
virtual bool receiveComplete(const void*, size_t, size_t&, size_t&,
size_t&, isc::util::OutputBufferPtr&)
......
......@@ -185,7 +185,8 @@ or HTTPS connection):
Control Channel is connection oriented communication. In that sense it is
different than all other communications supported so far in Kea. To facilitate
connections, several mechanisms were implemented. Intially a single UNIX socket
it opened (see isc::config::UnixCommandSocket). Its @ref
it opened (see @c isc::config::UnixCommandSocket in
src/lib/config/command_socket_factory.cc). Its @ref
isc::config::UnixCommandSocket::receiveHandler callback method is
installed in @ref isc::dhcp::IfaceMgr to process incoming connections. When the
select call in @ref isc::dhcp::IfaceMgr::receive4 indicates that there is some data to be
......
......@@ -129,7 +129,8 @@ public:
/// @brief Reads data from a socket, parses as JSON command and processes it
///
/// This method is used to handle traffic on connected socket. This callback
/// is installed by the @ref isc::config::UnixCommandSocket::receiveHandler
/// is installed by the @c isc::config::UnixCommandSocket::receiveHandler
/// (located in the src/lib/config/command_socket_factory.cc)
/// once the incoming connection is accepted. If end-of-file is detected, this
/// method will close the socket and will uninstall itself from
/// @ref isc::dhcp::IfaceMgr.
......
......@@ -28,7 +28,6 @@ namespace {
/// of a definition for option comprising a record of data fields.
///
/// @param name name of the array being declared.
/// @param types data types of fields that belong to the record.
#ifndef RECORD_DECL
#define RECORD_DECL(name, ...) const OptionDataType name[] = { __VA_ARGS__ }
#endif
......
......@@ -408,9 +408,9 @@ public:
/// response to SOLICIT).
///
/// This method uses host reservation if ctx.host_ is set. The easy way to
/// set it is to call @ref AllocEngine::findReservation(ctx). The host reservation
/// is convenient, but incurs performance penalty, so it can be tweaked on
/// a per subnet basis. There are three possible modes:
/// set it is to call @ref isc::dhcp::AllocEngine::findReservation(ctx).
/// The host reservation is convenient, but incurs performance penalty,
/// so it can be tweaked on a per subnet basis. There are three possible modes:
/// 1. disabled (no host reservation at all). This is the most performant one
/// as the code can skip all checks;
/// 2. out-of-pool (only reservations that are outside
......
......@@ -21,7 +21,7 @@
namespace isc {
namespace dhcp {
///@{
//@{
/// \brief Logging levels for the @c AllocEngine.
///
/// Defines the levels used to output debug messages from the @c AllocEngine.
......@@ -45,7 +45,7 @@ const int ALLOC_ENGINE_DBG_TRACE_DETAIL = DBGLVL_TRACE_DETAIL;
/// Messages logged at this level will contain detailed results.
const int ALLOC_ENGINE_DBG_TRACE_DETAIL_DATA = DBGLVL_TRACE_DETAIL_DATA;
///@}
//@}
/// @brief Logger for the @c AllocEngine..
///
......
......@@ -958,7 +958,7 @@ protected:
/// The elements currently supported are:
/// -# ip-address
///
/// @param config_id is the "item_name" for a specific member element of
/// @param parser is the "item_name" for a specific member element of
/// the "relay" specification.
///
/// @return returns a pointer to newly created parser.
......@@ -1058,6 +1058,8 @@ protected:
/// Allowed values are "disabled", "off" (alias for disabled),
/// "out-of-pool" and "all". See Subnet::HRMode for their exact meaning.
///
/// @param txt Host Reservation mode in the textual form.
///
/// @throw BadValue if the text cannot be converted.
///
/// @param text representation for conversion
......
......@@ -583,10 +583,8 @@ configuration. As soon as any specification is processed (even an
empty one), the buffered log messages will be flushed according to
the specification. Note that if this option is used, the program
SHOULD call one of the @ref isc::log::LoggerManager::process() calls.
(If you are using the built-in logging configuration handling in @ref
isc::config::ModuleCCSession, this is automatically handled.) If the
program exits before this is done, all log messages are dumped in a raw
format to stdout (so that no messages get lost).</dd>
If the program exits before this is done, all log messages are dumped
in a raw format to stdout (so that no messages get lost).</dd>
</dl>
@subsubsection logInitializationCppVariant2 Variant #2, Used by Unit Tests
......
......@@ -107,7 +107,7 @@ public:
///
/// It does not alter the actual value. It only marks it "specified" or
/// "unspecified".
/// @param specified boolean that determined if a value is specified or not
/// @param state determines if a value is specified or not
void specify(const OptionalValueState& state) {
specified_ = state.specified_;
}
......
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