]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#180,!93] More doxygen warnings fixed.
authorTomek Mrugalski <tomasz@isc.org>
Mon, 5 Nov 2018 07:09:07 +0000 (14:09 +0700)
committerTomek Mrugalski <tomasz@isc.org>
Mon, 5 Nov 2018 07:09:07 +0000 (14:09 +0700)
src/lib/config_backend/base_config_backend_pool.h
src/lib/database/database_connection.h
src/lib/dhcpsrv/cql_host_data_source.cc
src/lib/dhcpsrv/cql_host_data_source.h
src/lib/dhcpsrv/database_backends.dox
src/lib/dhcpsrv/mysql_host_data_source.cc

index 74388d1dc315f86215c3391655422aa2e009c972..d88940e2af51c5060564cab380c373847741d4da 100644 (file)
@@ -380,7 +380,7 @@ protected:
     /// This method selects backends matching the selector. If the selector is
     /// "unspecified" or there is no backend in the pool, an empty list is returned.
     ///
-    /// @param selector Selector for which matching backends should be selected.
+    /// @param backend_selector Selector for which matching backends should be selected.
     std::list<ConfigBackendTypePtr>
     selectBackends(const db::BackendSelector& backend_selector) const {
 
index 5770a143665c5069a1022e1053470e02aca4c185..854d8a4f1dec9c5d84a153b98e53c5c16b84a12f 100644 (file)
@@ -135,8 +135,8 @@ typedef boost::shared_ptr<ReconnectCtl> ReconnectCtlPtr;
 /// connection with different types of databases; enables operations
 /// on access parameters strings. In particular, it provides a way
 /// to parse parameters in key=value format. This class is expected
-/// to be a base class for all @ref LeaseMgr and possibly
-/// @ref BaseHostDataSource derived classes.
+/// to be a base class for all @ref isc::dhcp::LeaseMgr and possibly
+/// @ref isc::dhcp::BaseHostDataSource derived classes.
 class DatabaseConnection : public boost::noncopyable {
 public:
 
index a67d650fd8e818ff823a3956e1eb96fee76d0601..48ea9b6637b1271a672be8e7b1131209a2a64da3 100644 (file)
@@ -156,7 +156,7 @@ public:
     /// Creates a bind array to receive @ref Host data from the Cassandra
     /// database. After data is successfully received, @ref retrieve() can be
     /// called to retrieve the @ref Host object. Called in @ref
-    /// CqlExchange::executeSelect().
+    /// db::CqlExchange::executeSelect().
     ///
     /// @param data array of objects representing data being retrieved
     /// @param statement_tag prepared statement being executed; defaults to an
@@ -1504,7 +1504,7 @@ protected:
 
     /// @brief Retrieves a collection of hosts.
     ///
-    /// Calls @ref CqlExchange::executeSelect().
+    /// Calls @ref db::CqlExchange::executeSelect().
     ///
     /// @param where_values array of bound objects used to filter the results
     /// @param statement_tag prepared statement being executed
@@ -1516,7 +1516,7 @@ protected:
     /// @brief Inserts or deletes a single host.
     ///
     /// All information is available here. Calls @ref
-    /// CqlExchange::executeMutation().
+    /// db::CqlExchange::executeMutation().
     ///
     /// @param insert insert or delete a host
     /// @param host @ref Host object from which options are retrieved and
index 73768929559299a4a211cc7f132233f6e22f81d2..1b788eb7479a0f4893486681a8efd96a3ee96387 100644 (file)
@@ -71,7 +71,7 @@ public:
     /// - tcp-nodelay
     ///
     /// For details regarding those paraemters, see
-    /// @ref isc::dhcp::CqlConnection::openDatabase.
+    /// @ref isc::db::CqlConnection::openDatabase.
     ///
     /// Finally, all the CQL commands are pre-compiled.
     ///
@@ -95,7 +95,7 @@ public:
     /// The implementations of this method should guard against duplicate
     /// reservations for the same @ref Host, where possible. For example, when
     /// the reservation for the same @ref HWAddr and @ref SubnetID is added
-    /// twice, @ref add() should throw a @ref DuplicateEntry exception. Note,
+    /// twice, @ref add() should throw a @ref db::DuplicateEntry exception. Note,
     /// that usually it is impossible to guard against adding duplicated @ref
     /// Host, where one instance is identified by different identifier types.
     ///
index 59d73082cd6ecfed58964453b64e9c99e737e575..e7019accd623dd09cbcad3beb886a69865a0237c 100644 (file)
@@ -76,7 +76,7 @@
   - <b>user</b> - database user ID under which the database is accessed.  If not
     specified, no user ID is used - the database is assumed to be open.
 
-  For details, see @ref isc::dhcp::MySqlConnection::openDatabase().
+  For details, see @ref isc::db::MySqlConnection::openDatabase().
 
   @subsection dhcpdb-keywords-pgsql PostgreSQL connection string keywords
 
@@ -89,7 +89,7 @@
   - <b>user</b> - database user ID under which the database is accessed.  If not
     specified, no user ID is used - the database is assumed to be open.
 
-  For details, see @ref isc::dhcp::PgSqlConnection::openDatabase().
+  For details, see @ref isc::db::PgSqlConnection::openDatabase().
 
   @subsection dhcpdb-keywords-cql Cassandra (CQL) connection string keywords
 
   - <b>keyspace</b> - an optional keyspace. If not specified, the default value
     of 'keatest' will be used.
 
-  For details, see @ref isc::dhcp::CqlConnection::openDatabase().
+  For details, see @ref isc::db::CqlConnection::openDatabase().
 
   @section dhcpdb-host Host Backends
 
index b5e62a7a0b6b937a991b8a34439a8e56c81580be..fa9dfb236538c31f83412912f135e9f4a1c886e8 100644 (file)
@@ -2035,7 +2035,7 @@ public:
 
     /// @brief Check Error and Throw Exception
     ///
-    /// This method invokes @ref MySqlConnection::checkError.
+    /// This method invokes @ref db::MySqlConnection::checkError.
     ///
     /// @param status Status code: non-zero implies an error
     /// @param index Index of statement that caused the error