]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[4281] Fixed trivial doxygen errors.
authorMarcin Siodelski <marcin@isc.org>
Wed, 1 Jun 2016 15:35:44 +0000 (17:35 +0200)
committerMarcin Siodelski <marcin@isc.org>
Wed, 1 Jun 2016 15:35:44 +0000 (17:35 +0200)
src/lib/dhcpsrv/base_host_data_source.h
src/lib/dhcpsrv/cfg_host_operations.h
src/lib/dhcpsrv/host.h
src/lib/dhcpsrv/host_mgr.h
src/lib/dhcpsrv/mysql_host_data_source.cc
src/lib/dhcpsrv/mysql_host_data_source.h
src/lib/dhcpsrv/tests/generic_host_data_source_unittest.cc
src/lib/dhcpsrv/writable_host_data_source.h
src/lib/eval/token.h

index 8868a31093575f29d6084ecd1208203ba120b227..0230efcfbe426d7b9085f702134186b4116ac92f 100644 (file)
@@ -105,6 +105,7 @@ public:
     /// for a specified identifier. This method may return multiple hosts
     /// because a particular client may have reservations in multiple subnets.
     ///
+    /// @param identifier_type Identifier type.
     /// @param identifier_begin Pointer to a begining of a buffer containing
     /// an identifier.
     /// @param identifier_len Identifier length.
index 50ebbd1dc26c7c7d2fc01019707cf851fbff4721..eace0f8694643383898d2316098b23420d1340fb 100644 (file)
@@ -63,7 +63,7 @@ public:
     /// @brief Adds new identifier type to a collection of identifiers
     /// to be used by the server to search for host reservations.
     ///
-    /// @param identifier_type Name of the identifier to be added. It
+    /// @param identifier_name Name of the identifier to be added. It
     /// must be one of the names supported by the @ref Host::getIdentifierType
     /// function.
     void addIdentifierType(const std::string& identifier_name);
index 89fe0e0a00749b3243b74ec183e55ced9e0c5993..01435bf27921f3e674bb9df0235f22887f945aec 100644 (file)
@@ -317,7 +317,7 @@ public:
 
     /// @brief Returns host identifier in a textual form.
     ///
-    /// @return Identifier in the form of <type>=<value>.
+    /// @return Identifier in the form of type=value.
     std::string getIdentifierAsText() const;
 
     /// @brief Returns name of the identifier of a specified type.
@@ -328,7 +328,7 @@ public:
     /// @param type Identifier type.
     /// @param value Pointer to a buffer holding identifier.
     /// @param length Length of the identifier.
-    /// @return Identifier in the form of <type>=<value>.
+    /// @return Identifier in the form of type=value.
     static std::string getIdentifierAsText(const IdentifierType& type,
                                            const uint8_t* value,
                                            const size_t length);
index 37b8efee9198aa49b67e2f3d53a33493ff959003..f4633281b9cf7d6e22078f18ed2d0d57ccac2dae 100644 (file)
@@ -116,6 +116,7 @@ public:
     /// reservations from the primary data source are placed before the
     /// reservations from the alternate source.
     ///
+    /// @param identifier_type Identifier type.
     /// @param identifier_begin Pointer to a begining of a buffer containing
     /// an identifier.
     /// @param identifier_len Identifier length.
index 21c9d981e7607080d4b25448d9e7c6e4f53733d6..ff1c3d0c23e52189066fb69b1d52e9522b74ed05 100644 (file)
@@ -1709,7 +1709,7 @@ public:
                     const char* what) const;
 
     /// @brief Creates collection of @ref Host objects with associated
-    /// information such as IPv6 reservations and/or DHCP options..
+    /// information such as IPv6 reservations and/or DHCP options.
     ///
     /// This method performs a query which returns host information from
     /// the 'hosts' table. The query may also use LEFT JOIN clause to
index 345c819f3cb4559a59231d77790b2987b6746ea6..9ce64f2256ddc2e99499beda181678d2e9fb0b60 100644 (file)
@@ -84,6 +84,7 @@ public:
     /// for a specified identifier. This method may return multiple hosts
     /// because a particular client may have reservations in multiple subnets.
     ///
+    /// @param identifier_type Identifier type.
     /// @param identifier_begin Pointer to a begining of a buffer containing
     /// an identifier.
     /// @param identifier_len Identifier length.
index ba5971c426b47445b57f8d0ea1c1eb2d3dadfff0..bf2eced159dc6836b95a23b7802d5e0748616954 100644 (file)
@@ -12,7 +12,7 @@
 #include <dhcp/option_string.h>
 #include <dhcp/option_int.h>
 #include <dhcp/option_vendor.h>
-#include <dhcpsrv/mysql_connection.h>
+//#include <dhcpsrv/mysql_connection.h>
 #include <dhcpsrv/tests/generic_host_data_source_unittest.h>
 #include <dhcpsrv/tests/test_utils.h>
 #include <dhcpsrv/database_connection.h>
index 0dbee11629d8b18f8b239f0df5b28d7d88580c08..e30d36ef8c8459ab41f9ac9cf6abec304f65cd0f 100644 (file)
@@ -46,6 +46,7 @@ public:
     /// for a specified identifier. This method may return multiple hosts
     /// because a particular client may have reservations in multiple subnets.
     ///
+    /// @param identifier_type Identifier type.
     /// @param identifier_begin Pointer to a begining of a buffer containing
     /// an identifier.
     /// @param identifier_len Identifier length.
index 316106e43e246f5509109e557d4999ea1999e5c6..44f5e32542d5779e655c847ab94bbb3fadeadca2 100644 (file)
@@ -568,7 +568,7 @@ protected:
     uint8_t nest_level_; ///< nesting level of the relay block to use
 };
 
-/// @breif Token that represents a value of a field within a DHCPv6 relay
+/// @brief Token that represents a value of a field within a DHCPv6 relay
 /// encapsulation
 ///
 /// This represents a reference to a field with a given DHCPv6 relay encapsulation.