From: Tomek Mrugalski <tomek@isc.org>
Date: Fri, 8 Jul 2022 14:37:20 +0000 (+0200)
Subject: [#2454] Doxygen fixes
X-Git-Tag: Kea-2.2.0~36
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=283e5a0d8efe508a8b2ca968258b9256bfa65a66;p=thirdparty%2Fkea.git

[#2454] Doxygen fixes
---

diff --git a/src/lib/cc/simple_parser.h b/src/lib/cc/simple_parser.h
index 9f551282e2..cb788028fd 100644
--- a/src/lib/cc/simple_parser.h
+++ b/src/lib/cc/simple_parser.h
@@ -323,7 +323,7 @@ public:
     ///
     /// Parses an integer triplet parameter of the form:
     ///
-    ///    min-<name>, <name>, max-<name>
+    ///    min-{name}, {name}, max-{name}
     ///
     /// @param scope Data element holding e.g. shared network configuration
     /// to be parsed.
diff --git a/src/lib/dhcpsrv/cfg_expiration.h b/src/lib/dhcpsrv/cfg_expiration.h
index 76d1b4514b..0cf8457927 100644
--- a/src/lib/dhcpsrv/cfg_expiration.h
+++ b/src/lib/dhcpsrv/cfg_expiration.h
@@ -62,7 +62,7 @@ class CfgExpiration : public isc::data::CfgToElement {
 public:
 
     /// @name Default values.
-    //@{
+    ///@{
     ///
     /// @brief Default value for reclaim-timer-wait-time.
     static const uint16_t DEFAULT_RECLAIM_TIMER_WAIT_TIME;
@@ -82,10 +82,10 @@ public:
     /// @brief Default value for unwarned-reclaim-cycles.
     static const uint16_t DEFAULT_UNWARNED_RECLAIM_CYCLES;
 
-    //@}
+    ///@}
 
     /// @name Upper limits for the parameters
-    //@{
+    ///@{
     ///
     /// @brief Maximum value for reclaim-timer-wait-time.
     static const uint16_t LIMIT_RECLAIM_TIMER_WAIT_TIME;
@@ -105,10 +105,10 @@ public:
     /// @brief Maximum value for unwarned-reclaim-cycles.
     static const uint16_t LIMIT_UNWARNED_RECLAIM_CYCLES;
 
-    //@}
+    ///@}
 
     /// @name Timers' names
-    //@{
+    ///@{
 
     /// @brief Name of the timer for reclaiming expired leases.
     static const std::string RECLAIM_EXPIRED_TIMER_NAME;
@@ -116,7 +116,7 @@ public:
     /// @brief Name of the timer for flushing reclaimed leases.
     static const std::string FLUSH_RECLAIMED_TIMER_NAME;
 
-    //@}
+    ///@}
 
     /// @brief Constructor.
     ///
@@ -270,14 +270,14 @@ private:
 };
 
 /// @name Pointers to the @c CfgExpiration objects.
-//@{
+///@{
 /// @brief Pointer to the Non-const object.
 typedef boost::shared_ptr<CfgExpiration> CfgExpirationPtr;
 
 /// @brief Pointer to the const object.
 typedef boost::shared_ptr<const CfgExpiration> ConstCfgExpirationPtr;
 
-//@}
+///@}
 
 template<typename Instance>
 void
diff --git a/src/lib/http/basic_auth_config.h b/src/lib/http/basic_auth_config.h
index f3d8c3414c..413dd2266d 100644
--- a/src/lib/http/basic_auth_config.h
+++ b/src/lib/http/basic_auth_config.h
@@ -145,10 +145,10 @@ public:
     /// @brief Clear configuration.
     virtual void clear();
 
-    /// @brief Get the content of <directory>/<file-name> regular file.
+    /// @brief Get the content of {directory}/{file-name} regular file.
     ///
     /// @param file_name The file name.
-    /// @return The content of the <directory>/<file-name> regular file.
+    /// @return The content of the {directory}/{file-name} regular file.
     std::string getFileContent(const std::string& file_name) const;
 
     /// @brief Returns the list of client configuration.
diff --git a/src/lib/yang/yang.dox b/src/lib/yang/yang.dox
index dc587be944..c13238d1ec 100644
--- a/src/lib/yang/yang.dox
+++ b/src/lib/yang/yang.dox
@@ -119,7 +119,7 @@ Reference Manual: https://kea.readthedocs.io/en/latest/arm/integrations.html#yan
 
 You also need to install YANG modules, so the unit tests are able to
 retrieve, add, update and generally interact with the sysrepo information.
-There are several Kea modules (src/share/yang/modules/*.yang), mostly usable in
+There are several Kea modules (*.yang in src/share/yang/modules/), mostly usable in
 production, but one called keatest-module is only used in unit tests. To be able
 to run unit tests as a non-root user, which is the recommended way, make sure
 the sysrepo repository and /dev/shm/sr* are owned by said user. One way to