From: Razvan Becheriu <razvan@isc.org>
Date: Tue, 29 Oct 2019 10:46:27 +0000 (+0200)
Subject: [#887,!572] updated doxygen
X-Git-Url: http://git.ipfire.org/gitweb/gitweb.cgi?a=commitdiff_plain;h=63a12a7a112fd8c7e6a8243b5d388398061934e6;p=thirdparty%2Fkea.git

[#887,!572] updated doxygen
---

diff --git a/src/lib/mysql/mysql_connection.h b/src/lib/mysql/mysql_connection.h
index e79f71d5be..118e388fdf 100644
--- a/src/lib/mysql/mysql_connection.h
+++ b/src/lib/mysql/mysql_connection.h
@@ -108,11 +108,39 @@ public:
         // @note Moved the call to mysql_library_end() to atexit.
     }
 
+    /// @brief Clear all resources
+    ///
+    /// Clear all resources.
+    void clear() {
+        setConnection(NULL);
+    }
+
+    /// @brief Clear prepared statements
+    ///
+    /// Clear prepared statements.
+    void clearPrepared();
+
     /// @brief Sets the connection to the value given
     ///
-    /// @param connection - pointer to the MYSQL connection instance
+    /// Sets the database back-end object.
+    ///
+    /// @param connection - pointer to the MySql connection instance
     void setConnection(MYSQL* connection);
 
+    /// @brief Open database
+    ///
+    /// Open database and apply MySql connection parameters.
+    ///
+    /// @param connection - associated connection which holds connection properties.
+    void openDatabase(MySqlConnection& connection);
+
+    /// @brief Prepare statements
+    ///
+    /// Prepare statements.
+    ///
+    /// @param connection - associated connection which holds the text statements.
+    void prepareStatements(MySqlConnection& connection);
+
     /// @brief Conversion Operator
     ///
     /// Allows the MySqlHolder object to be passed as the context argument to
@@ -121,27 +149,20 @@ public:
         return (mysql_);
     }
 
-    void clear() {
-        setConnection(NULL);
-    }
-
-    void clearPrepared();
-
-    void openDatabase(MySqlConnection& connection);
-
-    void prepareStatements(MySqlConnection& connection);
-
     /// @brief Prepared statements
     ///
     /// This field is public, because it is used heavily from MySqlConnection
     /// and from MySqlHostDataSource.
     std::vector<MYSQL_STMT*> statements_;
 
+    /// @brief The connected flag
     bool connected_;     ///< Flag to indicate openDatabase has been called
 
 private:
+    /// @brief The prepared flag
     bool prepared_;      ///< Flag to indicate prepareStatements has been called
 
+    /// @brief The atexit parameter called only once on initialization
     static bool atexit_; ///< Flag to call atexit once.
 
     /// @brief The MySql database back-end object associated to this holder