Parcourir la source

[1960] Fixed doxygen documentation.

Marcin Siodelski il y a 12 ans
Parent
commit
40ee3e7167
2 fichiers modifiés avec 7 ajouts et 4 suppressions
  1. 5 2
      tests/tools/perfdhcp/stats_mgr.h
  2. 2 2
      tests/tools/perfdhcp/test_control.h

+ 5 - 2
tests/tools/perfdhcp/stats_mgr.h

@@ -256,6 +256,8 @@ public:
         /// \brief Constructor
         /// \brief Constructor
         ///
         ///
         /// \param xchg_type exchange type
         /// \param xchg_type exchange type
+        /// \param drop_time maximum time elapsed before packet is
+        /// assumed dropped. Negative value disables it.
         /// \param archive_enabled if true packets archive mode is enabled.
         /// \param archive_enabled if true packets archive mode is enabled.
         /// In this mode all packets are stored throughout the test execution.
         /// In this mode all packets are stored throughout the test execution.
         ExchangeStats(const ExchangeType xchg_type,
         ExchangeStats(const ExchangeType xchg_type,
@@ -825,8 +827,6 @@ public:
     /// for performance reasons and to avoid waste of memory for storing
     /// for performance reasons and to avoid waste of memory for storing
     /// large list of archived packets.
     /// large list of archived packets.
     ///
     ///
-    /// \param drop_time maximum time elapsed before packet is
-    /// assumed dropped. Negative value disables it.
     /// \param archive_enabled true indicates that packets
     /// \param archive_enabled true indicates that packets
     /// archive mode is enabled.
     /// archive mode is enabled.
     StatsMgr(const bool archive_enabled = false) :
     StatsMgr(const bool archive_enabled = false) :
@@ -842,6 +842,8 @@ public:
     /// type.
     /// type.
     ///
     ///
     /// \param xchg_type exchange type.
     /// \param xchg_type exchange type.
+    /// \param drop_time maximum time elapsed before packet is
+    /// assumed dropped. Negative value disables it.
     /// \throw isc::BadValue if exchange of specified type exists.
     /// \throw isc::BadValue if exchange of specified type exists.
     void addExchangeStats(const ExchangeType xchg_type,
     void addExchangeStats(const ExchangeType xchg_type,
                           const double drop_time = -1) {
                           const double drop_time = -1) {
@@ -906,6 +908,7 @@ public:
     /// Increement counter value by one.
     /// Increement counter value by one.
     ///
     ///
     /// \param counter_key key poiting to the counter in the counters map.
     /// \param counter_key key poiting to the counter in the counters map.
+    /// \param value value to increment counter by.
     /// \return pointer to specified counter after incrementation.
     /// \return pointer to specified counter after incrementation.
     const CustomCounter& incrementCounter(const std::string& counter_key,
     const CustomCounter& incrementCounter(const std::string& counter_key,
                                           const uint64_t value = 1) {
                                           const uint64_t value = 1) {

+ 2 - 2
tests/tools/perfdhcp/test_control.h

@@ -531,8 +531,8 @@ protected:
     /// \brief Receive DHCPv4 or DHCPv6 packets from the server.
     /// \brief Receive DHCPv4 or DHCPv6 packets from the server.
     ///
     ///
     /// Method receives DHCPv4 or DHCPv6 packets from the server.
     /// Method receives DHCPv4 or DHCPv6 packets from the server.
-    /// This function will call \ref receivePacket4 or
-    /// \ref receivePacket6 depending if DHCPv4 or DHCPv6 packet
+    /// This function will call \ref processReceivedPacket4 or
+    /// \ref processReceivedPacket6 depending if DHCPv4 or DHCPv6 packet
     /// has arrived.
     /// has arrived.
     ///
     ///
     /// \warning this method does not check if provided socket is
     /// \warning this method does not check if provided socket is