[#3253] Doxygen clean up

../../../../doc/devel/Doxyfile
    Added perfmon dir

modified:
    alarm.h
    alarm_store.h
    monitored_duration_store.h

diff --git a/doc/devel/Doxyfile b/doc/devel/Doxyfile
index 57c153d864bda26d84b65626e6f1d3d5cf4829a3..967d656a2b8c60263bd50e308a1e160fbd4b409f 100644 (file)
--- a/doc/devel/Doxyfile
+++ b/doc/devel/Doxyfile
@@ -950,6 +950,7 @@ INPUT                  = ../../src/bin/agent \
                          ../../src/hooks/dhcp/flex_option \
                          ../../src/hooks/dhcp/high_availability \
                          ../../src/hooks/dhcp/lease_cmds \
+                         ../../src/hooks/dhcp/perfmon \
                          ../../src/hooks/dhcp/stat_cmds \
                          ../../src/hooks/dhcp/user_chk \
                          ../../src/lib/asiodns \

diff --git a/src/hooks/dhcp/perfmon/alarm.h b/src/hooks/dhcp/perfmon/alarm.h
index 5797a84e2131daa8247f3bfe5aa60e725a087da6..0e1427742daa35bc13c582221d3674d3fb13d0f2 100644 (file)
--- a/src/hooks/dhcp/perfmon/alarm.h
+++ b/src/hooks/dhcp/perfmon/alarm.h
@@ -33,10 +33,10 @@ public:
     /// @param response_type message type of the response packet
     /// @param start_event_label label of the start event
     /// @param end_event_label label of the end event
-    /// @param SubnetID subnet_id id of the selected subnet
+    /// @param subnet_id SubnetID of the selected subnet
     /// @param low_water threshold below which the average duration must fall to clear the alarm
-    /// @brief high_water threshold above which the average duration must rise to trigger the alarm.
-    /// @brief enabled true sets state to CLEAR, otherwise DISABLED, defaults to true.
+    /// @param high_water threshold above which the average duration must rise to trigger the alarm.
+    /// @param enabled true sets state to CLEAR, otherwise DISABLED, defaults to true.
     Alarm(uint16_t family, uint8_t query_type, uint8_t response_type,
           const std::string& start_event_label, const std::string& end_event_label,
           dhcp::SubnetID subnet_id,
@@ -46,8 +46,8 @@ public:
     ///
     /// @param key composite key that identifies the alarm
     /// @param low_water threshold below which the average duration must fall to clear the alarm
-    /// @brief high_water threshold above which the average duration must rise to trigger the alarm.
-    /// @brief enabled true sets state to CLEAR, otherwise DISABLED, defaults to true.
+    /// @param high_water threshold above which the average duration must rise to trigger the alarm.
+    /// @param enabled true sets state to CLEAR, otherwise DISABLED, defaults to true.
     Alarm(const DurationKey& key, const Duration& low_water, const Duration& high_water, bool enabled = true);
 
     /// @brief Destructor

diff --git a/src/hooks/dhcp/perfmon/alarm_store.h b/src/hooks/dhcp/perfmon/alarm_store.h
index 46fa1e109fff90a82b8b0ae8793fa9bf1ddcd75a..103f53ea2f3a383389936b0ba1d05d8fc32e33e6 100644 (file)
--- a/src/hooks/dhcp/perfmon/alarm_store.h
+++ b/src/hooks/dhcp/perfmon/alarm_store.h
@@ -38,9 +38,9 @@ struct AlarmPrimaryKeyTag { };
 
 /// @brief A multi index container holding pointers to Alarms.
 ///
-/// The durations in the container may be accessed using different indexes:
-/// - using the full key index
-///   <TBD>
+/// The alarms in the container may be accessed using different indexes:
+/// - using the index on DurationKey members, AlarmPrimaryKeyTag
+/// - others to follow based on API
 ///
 /// Indexes can be accessed using the index number (from 0 to n) or a
 /// name tag. It is recommended to use the tags to access indexes as
@@ -68,7 +68,7 @@ typedef boost::shared_ptr<AlarmCollection> AlarmCollectionPtr;
 ///
 /// Provides essential CRUD functions for managing a collection of
 /// Alarms.  Additionally there are finders that can return
-/// durations by DurationKey  <TBD>
+/// durations by DurationKey (others are TBD).
 /// All finders return copies of the durations found, rather than the
 /// stored duration itself.
 class AlarmStore {
@@ -106,8 +106,8 @@ public:
     ///
     /// @param key key value of the Alarm to create.
     /// @param low_water threshold below which the average duration must fall to clear the alarm
-    /// @brief high_water threshold above which the average duration must rise to trigger the alarm.
-    /// @brief enabled true sets state to CLEAR, otherwise DISABLED, defaults to true.
+    /// @param high_water threshold above which the average duration must rise to trigger the alarm.
+    /// @param enabled true sets state to CLEAR, otherwise DISABLED, defaults to true.
     ///
     /// @return pointer to the newly created Alarm.
     /// @throw DuplicateAlarm if a duration for the given key already exists in

diff --git a/src/hooks/dhcp/perfmon/monitored_duration_store.h b/src/hooks/dhcp/perfmon/monitored_duration_store.h
index 4e25edfaa2c2b438f90180169e76eaa726d9f006..f0acfba69f6e5d72fe0d57b10c034bd524b26c4a 100644 (file)
--- a/src/hooks/dhcp/perfmon/monitored_duration_store.h
+++ b/src/hooks/dhcp/perfmon/monitored_duration_store.h
@@ -39,8 +39,8 @@ struct DurationKeyTag { };
 /// @brief A multi index container holding pointers to MonitoredDurations.
 ///
 /// The durations in the container may be accessed using different indexes:
-/// - using the full key index
-///   <TBD>
+/// - using the index on DurationKey members, DurationKeyTag
+/// - others to follow based on API
 ///
 /// Indexes can be accessed using the index number (from 0 to n) or a
 /// name tag. It is recommended to use the tags to access indexes as
@@ -68,7 +68,7 @@ typedef boost::shared_ptr<MonitoredDurationCollection> MonitoredDurationCollecti
 ///
 /// Provides essential CRUD functions for managing a collection of
 /// MonitoredDurations.  Additionally there are finders that can return
-/// durations by DurationKey  <TBD>
+/// durations by DurationKey (others are TBD)
 /// All finders return copies of the durations found, rather than the
 /// stored duration itself.
 class MonitoredDurationStore {