Commit 7e612258 authored by Francis Dupont's avatar Francis Dupont
Browse files

[4234] doxygen cleanup first pass

parent 6bc8c1cb
......@@ -119,7 +119,7 @@ public:
virtual ~DControllerBase();
/// @brief returns Kea version on stdout and exit.
/// redeclaration/redefinition. @ref Daemon::getVersion()
/// redeclaration/redefinition. @ref isc::dhcp::Daemon::getVersion()
static std::string getVersion(bool extended);
/// @brief Acts as the primary entry point into the controller execution
......
......@@ -39,7 +39,7 @@ 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 @c
isc::dhcp::SubnetConfigParser, which implements the common base for both
DHCPv4 and DHCPv6 subnets. The @ref isc::dhcp::Subnet4ConfigParser
DHCPv4 and DHCPv6 subnets. The @ref Subnet4ConfigParser
implements the @c initSubnet abstract method, which creates an instance of
the DHCPv4 subnet. This method is invoked by the parent class.
......@@ -233,7 +233,7 @@ library. See ticket #3275. The class specific behavior is:
- docsis3.0 packets have file field set to the content of the boot-file-name option
- eRouter1.0 packets have siaddr (next server) field cleared
Aforementioned modifications are conducted in @ref isc::dhcp::Dhcpv4Srv::classSpecificProcessing.
Aforementioned modifications are conducted in @ref isc::dhcp::Dhcpv4Srv::vendorClassSpecificProcessing.
It is possible to define class restrictions in subnet, so a given subnet is only
accessible to clients that belong to a given class. That is implemented as isc::dhcp::Pkt4::classes_
......
......@@ -577,8 +577,7 @@ private:
///
/// @param lease lease to be declined
/// @param decline client's message
void
declineLease(const Lease4Ptr& lease, const Pkt4Ptr& decline);
void declineLease(const Lease4Ptr& lease, const Pkt4Ptr& decline);
protected:
......@@ -731,7 +730,7 @@ protected:
///
/// @note This is done in two phases: first the content of the
/// vendor-class-identifier option is used as a class, by
/// calling @ref classifyByVendor(). Second classification match
/// calling @ref classifyByVendor. Second classification match
/// expressions are evaluated. The resulting classes will be stored
/// in the packet (see @ref isc::dhcp::Pkt4::classes_ and
/// @ref isc::dhcp::Pkt4::inClass).
......
......@@ -39,7 +39,7 @@ 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 @c
isc::dhcp::SubnetConfigParser, which implements the common base for both
DHCPv4 and DHCPv6 subnets. The @ref isc::dhcp::Subnet6ConfigParser
DHCPv4 and DHCPv6 subnets. The @ref Subnet6ConfigParser
implements the @c initSubnet abstract method, which creates an instance of
the DHCPv6 subnet. This method is invoked by the parent class.
......@@ -236,7 +236,7 @@ check whether a packet belongs to given class, isc::dhcp::Pkt6::inClass method s
be used.
Currently there is no class behavior coded in DHCPv6, hence no v6 equivalent of
@ref isc::dhcp::Dhcpv4Srv::classSpecificProcessing. Should any need for such a code arise,
@ref isc::dhcp::Dhcpv4Srv::vendorClassSpecificProcessing. Should any need for such a code arise,
it will be conducted in an external hooks library.
It is possible to define class restrictions in subnet, so a given subnet is only
......
......@@ -623,7 +623,7 @@ protected:
///
/// @note This is done in two phases: first the content of the
/// vendor-class-identifier option is used as a class, by
/// calling @ref classifyByVendor(). Second classification match
/// calling @ref classifyByVendor. Second classification match
/// expressions are evaluated. The resulting classes will be stored
/// in the packet (see @ref isc::dhcp::Pkt6::classes_ and
/// @ref isc::dhcp::Pkt6::inClass).
......@@ -678,7 +678,7 @@ protected:
///
/// @param decline Decline messege sent by a client
/// @param reply Server's response (IA_NA with status will be added here)
/// @param client context
/// @param ctx context
/// @return true when expected to continue, false when hooks told us to drop
/// the packet
bool declineLeases(const Pkt6Ptr& decline, Pkt6Ptr& reply,
......
......@@ -246,8 +246,10 @@ public:
/// @brief Subtracts one address from another (a - b)
///
/// Treats addresses as integers and subtracts them. For example:
/// @code
/// 192.0.2.5 - 192.0.2.0 = 0.0.0.5
/// fe80::abcd - fe80:: = ::abcd
/// @endcode
///
/// It is possible to subtract greater from lesser address, e.g.
/// 192.168.56.10 - 192.168.67.20, but please do understand that
......
......@@ -397,7 +397,7 @@ public:
/// response to SOLICIT).
///
/// This method uses host reservation if ctx.host_ is set. The easy way to
/// set it is to call @ref isc::dhcp::AllocEngine::findReservation(ctx).
/// set it is to call @ref isc::dhcp::AllocEngine::findReservation(ClientContext6& 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
......@@ -524,9 +524,9 @@ public:
/// declined state). Therefore remove_leases parameter is ignored for
/// declined leases. They are always removed.
///
/// Also, for declined leases @ref reclaimDeclined is called. It conducts
/// several declined specific operation (extra log entry, stats dump,
/// hooks).
/// Also, for declined leases @ref reclaimDeclined(const Lease6Ptr&) is
/// called. It conducts several declined specific operation (extra log
/// entry, stats dump, hooks).
///
/// @param max_leases Maximum number of leases to be reclaimed.
/// @param timeout Maximum amount of time that the reclaimation routine
......@@ -582,9 +582,9 @@ public:
/// declined state). Therefore remove_leases parameter is ignored for
/// declined leases. They are always removed.
///
/// Also, for declined leases @ref reclaimDeclined is called. It conducts
/// several declined specific operation (extra log entry, stats dump,
/// hooks).
/// Also, for declined leases @ref reclaimDeclined(const Lease4Ptr&) is
/// called. It conductsseveral declined specific operation (extra log
/// entry, stats dump, hooks).
///
/// @param max_leases Maximum number of leases to be reclaimed.
/// @param timeout Maximum amount of time that the reclaimation routine
......
......@@ -12,7 +12,7 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
/// @file Defines the logger used by the @c isc::dhcp::HostMgr
/// @brief Defines the logger used by the @c isc::dhcp::HostMgr
#include "dhcpsrv/alloc_engine_log.h"
......
......@@ -22,7 +22,7 @@ namespace isc {
namespace dhcp {
//@{
/// \brief Logging levels for the @c AllocEngine.
/// @brief Logging levels for the @c AllocEngine.
///
/// Defines the levels used to output debug messages from the @c AllocEngine.
......@@ -47,7 +47,7 @@ const int ALLOC_ENGINE_DBG_TRACE_DETAIL_DATA = DBGLVL_TRACE_DETAIL_DATA;
//@}
/// @brief Logger for the @c AllocEngine..
/// @brief Logger for the @c AllocEngine.
///
/// Define the logger used to log messages in @c AllocEngine.
extern isc::log::Logger alloc_engine_logger;
......
......@@ -83,7 +83,7 @@ public:
/// @brief Sets the class's option collection
///
/// @param options the option collection to assign the class
/// @param cfg_option the option collection to assign the class
void setCfgOption(const CfgOptionPtr& cfg_option);
/// @brief Compares two @c ClientClassDef objects for equality.
......
......@@ -12,7 +12,7 @@
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
/// @file Defines the logger used by the @c isc::dhcp::HostMgr
/// @brief Defines the logger used by the @c isc::dhcp::HostMgr
#include "dhcpsrv/hosts_log.h"
......
......@@ -46,7 +46,7 @@
///
/// -# "option-data" - a list which defines the options that should be
/// assigned to memebers of the class. This element is optional and parsed
/// using the @ref dhcp::OptionDataListParser.
/// using the @ref isc::dhcp::OptionDataListParser.
///
/// ExpressionParser - creates an eval::Expression from a string element,
/// using the Eval Parser.
......@@ -171,7 +171,7 @@ public:
/// @param class_def_list pointer to an element that holds entries
/// for client class definitions.
/// @throw DhcpConfigError if configuration parsing fails.
void build(isc::data::ConstElementPtr option_def_list);
void build(isc::data::ConstElementPtr class_def_list);
/// @brief Commits class definitions to CfgMgr's global storage.
void commit();
......
......@@ -1083,7 +1083,6 @@ protected:
///
/// @throw BadValue if the text cannot be converted.
///
/// @param text representation for conversion
/// @return one of allowed HRMode values
static Subnet::HRMode hrModeFromText(const std::string& txt);
......
......@@ -408,7 +408,7 @@ class CAA : public Rdata {
public:
// BEGIN_COMMON_MEMBERS
explicit CAA(const std::string& type_str);
explicit CAA(const std::string& caa_str);
CAA(isc::util::InputBuffer& buffer, size_t rdata_len);
CAA(const CAA& other);
CAA(
......@@ -2304,7 +2304,7 @@ class TLSA : public Rdata {
public:
// BEGIN_COMMON_MEMBERS
explicit TLSA(const std::string& type_str);
explicit TLSA(const std::string& tlsa_str);
TLSA(isc::util::InputBuffer& buffer, size_t rdata_len);
TLSA(const TLSA& other);
TLSA(
......
......@@ -212,7 +212,8 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param buffer An output buffer to store the wire data.
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRClass is to be stored.
void toWire(AbstractMessageRenderer& renderer) const;
/// \brief Render the \c RRClass in the wire format.
///
......@@ -222,8 +223,7 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRClass is to be stored.
/// \param buffer An output buffer to store the wire data.
void toWire(isc::util::OutputBuffer& buffer) const;
//@}
......
......@@ -219,7 +219,8 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param buffer An output buffer to store the wire data.
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRClass is to be stored.
void toWire(AbstractMessageRenderer& renderer) const;
/// \brief Render the \c RRClass in the wire format.
///
......@@ -229,8 +230,7 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRClass is to be stored.
/// \param buffer An output buffer to store the wire data.
void toWire(isc::util::OutputBuffer& buffer) const;
//@}
......
......@@ -185,7 +185,8 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param buffer An output buffer to store the wire data.
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRType is to be stored.
void toWire(AbstractMessageRenderer& renderer) const;
/// \brief Render the \c RRType in the wire format.
///
......@@ -195,8 +196,7 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRType is to be stored.
/// \param buffer An output buffer to store the wire data.
void toWire(isc::util::OutputBuffer& buffer) const;
//@}
......
......@@ -192,7 +192,8 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param buffer An output buffer to store the wire data.
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRType is to be stored.
void toWire(AbstractMessageRenderer& renderer) const;
/// \brief Render the \c RRType in the wire format.
///
......@@ -202,8 +203,7 @@ public:
/// If resource allocation in rendering process fails, a corresponding
/// standard exception will be thrown.
///
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRType is to be stored.
/// \param buffer An output buffer to store the wire data.
void toWire(isc::util::OutputBuffer& buffer) const;
//@}
......
......@@ -114,6 +114,8 @@ public:
/// \param secret Point to a binary sequence of the shared secret to be
/// used for this key, or \c NULL if the secret is empty.
/// \param secret_len The size of the binary %data (\c secret) in bytes.
/// \param digestbits The number of bits to include in the digest
/// (0 means to include all)
TSIGKey(const Name& key_name, const Name& algorithm_name,
const void* secret, size_t secret_len, size_t digestbits = 0);
......
......@@ -119,7 +119,7 @@ public:
/// @brief Trims a given number of elements from the end of a row
///
/// @param number of elements to trim
/// @param count number of elements to trim
///
/// @throw CSVFileError if the number to trim is larger than
/// then the number of elements
......
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