From: Razvan Becheriu <razvan@isc.org>
Date: Mon, 31 Mar 2025 18:05:55 +0000 (+0300)
Subject: [#3569] added doxygen
X-Git-Tag: Kea-2.7.8~85
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6c0444a0e337b3401e19644113d00a5a7ea46e97;p=thirdparty%2Fkea.git

[#3569] added doxygen
---

diff --git a/src/hooks/dhcp/forensic_log/legal_syslog.h b/src/hooks/dhcp/forensic_log/legal_syslog.h
index f72250dff8..381e25d382 100644
--- a/src/hooks/dhcp/forensic_log/legal_syslog.h
+++ b/src/hooks/dhcp/forensic_log/legal_syslog.h
@@ -16,6 +16,11 @@ class LegalSyslog : public isc::dhcp::LegalLogMgr {
 public:
     /// @brief Constructor.
     ///
+    /// @note The supported parameters are:
+    /// - syslog parameters:
+    ///       - pattern
+    ///       - facility
+    ///
     /// @param parameters A data structure relating keywords and values
     ///        concerned with the manager configuration.
     LegalSyslog(const isc::db::DatabaseConnection::ParameterMap& parameters);
diff --git a/src/hooks/dhcp/forensic_log/rotating_file.h b/src/hooks/dhcp/forensic_log/rotating_file.h
index 866e0ee5e7..f7e4b0b3e2 100644
--- a/src/hooks/dhcp/forensic_log/rotating_file.h
+++ b/src/hooks/dhcp/forensic_log/rotating_file.h
@@ -67,6 +67,15 @@ public:
     /// 'count' number of days, months or years (when the write function call
     /// detects that the day, month or year has changed).
     ///
+    /// @note The supported parameters are:
+    /// - logfile parameters:
+    ///       - path
+    ///       - base-name
+    ///       - time-unit - one of: second, day, month, year
+    ///       - prerotate
+    ///       - postrotate
+    ///       - count
+    ///
     /// @param parameters A data structure relating keywords and values
     ///        concerned with the manager configuration.
     ///
diff --git a/src/hooks/dhcp/mysql/mysql_legal_log.h b/src/hooks/dhcp/mysql/mysql_legal_log.h
index 603161ae9e..1733e69fc3 100644
--- a/src/hooks/dhcp/mysql/mysql_legal_log.h
+++ b/src/hooks/dhcp/mysql/mysql_legal_log.h
@@ -87,17 +87,24 @@ public:
 
     /// @brief Constructor
     ///
-    /// The following keywords in the parameters passed to it will be used
-    /// to connect to the database:
-    /// - name - Name of the database to which to connect (mandatory)
-    /// - host - Host to which to connect (optional, defaults to "localhost")
-    /// - user - Username under which to connect (optional)
-    /// - password - Password for "user" on the database (optional)
-    /// - trust-anchor - Trust anchor aka certificate authority file
-    ///   or directory (optional)
-    /// - cert-file - Client certificate file name (optional)
-    /// - key-file - Private key file name (optional)
-    /// - cipher-list - Cipher list (optional)
+    /// @note The supported parameters are:
+    /// - database parameters:
+    ///       - name
+    ///       - host
+    ///       - password
+    ///       - port
+    ///       - user
+    ///       - trust-anchor (MySQL only)
+    ///       - cert-file (MySQL only)
+    ///       - key-file (MySQL only)
+    ///       - cipher-list (MySQL only)
+    ///       - reconnect-wait-time
+    ///       - max-reconnect-tries
+    ///       - on-fail
+    ///       - retry-on-startup
+    ///       - connect-timeout
+    ///       - read-timeout (MySQL only)
+    ///       - write-timeout (MySQL only)
     ///
     /// @param parameters A data structure relating keywords and values
     ///        concerned with the database.
diff --git a/src/hooks/dhcp/pgsql/pgsql_legal_log.h b/src/hooks/dhcp/pgsql/pgsql_legal_log.h
index 7b4369cd6a..b6cb375fd9 100644
--- a/src/hooks/dhcp/pgsql/pgsql_legal_log.h
+++ b/src/hooks/dhcp/pgsql/pgsql_legal_log.h
@@ -86,13 +86,19 @@ public:
 
     /// @brief Constructor
     ///
-    /// The following keywords in the parameters passed to it will be used
-    /// to connect to the database:
-    /// - name - Name of the database to which to connect (mandatory)
-    /// - host - Host to which to connect (optional, defaults to "localhost")
-    /// - user - Username under which to connect (optional)
-    /// - password - Password for "user" on the database (optional)
-    /// - trust-anchor, cert-file, key-file and cipher-list (ignored)
+    /// @note The supported parameters are:
+    /// - database parameters:
+    ///       - name
+    ///       - host
+    ///       - password
+    ///       - port
+    ///       - user
+    ///       - reconnect-wait-time
+    ///       - max-reconnect-tries
+    ///       - on-fail
+    ///       - retry-on-startup
+    ///       - connect-timeout
+    ///       - tcp-user-timeout (PostgreSQL only)
     ///
     /// @param parameters A data structure relating keywords and values
     ///        concerned with the database.