From: Tomek Mrugalski Date: Mon, 5 Nov 2018 07:09:07 +0000 (+0700) Subject: [#180,!93] More doxygen warnings fixed. X-Git-Tag: 66-authoritative-flag-in-kea_base~34^2~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=63dc9ec8cf67574f388bd9686cacfdff32a48c3b;p=thirdparty%2Fkea.git [#180,!93] More doxygen warnings fixed. --- diff --git a/src/lib/config_backend/base_config_backend_pool.h b/src/lib/config_backend/base_config_backend_pool.h index 74388d1dc3..d88940e2af 100644 --- a/src/lib/config_backend/base_config_backend_pool.h +++ b/src/lib/config_backend/base_config_backend_pool.h @@ -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 selectBackends(const db::BackendSelector& backend_selector) const { diff --git a/src/lib/database/database_connection.h b/src/lib/database/database_connection.h index 5770a14366..854d8a4f1d 100644 --- a/src/lib/database/database_connection.h +++ b/src/lib/database/database_connection.h @@ -135,8 +135,8 @@ typedef boost::shared_ptr 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: diff --git a/src/lib/dhcpsrv/cql_host_data_source.cc b/src/lib/dhcpsrv/cql_host_data_source.cc index a67d650fd8..48ea9b6637 100644 --- a/src/lib/dhcpsrv/cql_host_data_source.cc +++ b/src/lib/dhcpsrv/cql_host_data_source.cc @@ -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 diff --git a/src/lib/dhcpsrv/cql_host_data_source.h b/src/lib/dhcpsrv/cql_host_data_source.h index 7376892955..1b788eb747 100644 --- a/src/lib/dhcpsrv/cql_host_data_source.h +++ b/src/lib/dhcpsrv/cql_host_data_source.h @@ -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. /// diff --git a/src/lib/dhcpsrv/database_backends.dox b/src/lib/dhcpsrv/database_backends.dox index 59d73082cd..e7019accd6 100644 --- a/src/lib/dhcpsrv/database_backends.dox +++ b/src/lib/dhcpsrv/database_backends.dox @@ -76,7 +76,7 @@ - user - 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 @@ - user - 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 @@ -103,7 +103,7 @@ - keyspace - 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 diff --git a/src/lib/dhcpsrv/mysql_host_data_source.cc b/src/lib/dhcpsrv/mysql_host_data_source.cc index b5e62a7a0b..fa9dfb2365 100644 --- a/src/lib/dhcpsrv/mysql_host_data_source.cc +++ b/src/lib/dhcpsrv/mysql_host_data_source.cc @@ -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