[3156] Corrected a few doxygen errors.

diff --git a/src/bin/d2/d2_cfg_mgr.h b/src/bin/d2/d2_cfg_mgr.h
index c9b794ffcc0eac7cef1937263a4a95e6b00cf3d5..d95a8902dbc5fe1dc4829d65b1d7182eafd5ac30 100644 (file)
--- a/src/bin/d2/d2_cfg_mgr.h
+++ b/src/bin/d2/d2_cfg_mgr.h
@@ -199,7 +199,7 @@ public:
     /// output:
     ///0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.9.9.0.0.2.0.3.0.8.B.D.0.1.0.0.2.ip6.arpa.
     ///
-    /// @param address string containing a valid IPv6 address.
+    /// @param ioaddr string containing a valid IPv6 address.
     ///
     /// @return a std::string containing the reverse order address.
     ///

diff --git a/src/bin/d2/nc_trans.h b/src/bin/d2/nc_trans.h
index 6b58b5d8eb153bf5d2fc29b11ea198372c5f6c91..63216e6b8788fe14b93473a8128dad8c0b71f3fe 100644 (file)
--- a/src/bin/d2/nc_trans.h
+++ b/src/bin/d2/nc_trans.h
@@ -109,7 +109,7 @@ public:
 
     static const int PROCESS_TRANS_FAILED_ST = SM_STATE_MAX + 5;
 
-    /// @define Value at which custom states in a derived class should begin.
+    /// @brief Value at which custom states in a derived class should begin.
     static const int NCT_STATE_MAX = SM_STATE_MAX + 100;
     //@}
 
@@ -138,7 +138,7 @@ public:
     /// packet (if one was received).
     static const int UPDATE_FAILED_EVT = SM_EVENT_MAX + 7;
 
-    /// @define Value at which custom events in a derived class should begin.
+    /// @brief Value at which custom events in a derived class should begin.
     static const int NCT_EVENT_MAX = SM_EVENT_MAX + 100;
     //@}
 

diff --git a/src/bin/d2/state_model.h b/src/bin/d2/state_model.h
index 43d8c08fb8d9697a6b389e305656503bb49a01ab..44bab765c4feb8be26ff52212093715c4fd12dbe 100644 (file)
--- a/src/bin/d2/state_model.h
+++ b/src/bin/d2/state_model.h
@@ -245,7 +245,7 @@ public:
     /// @brief Final state, all the state model has reached its conclusion.
     static const int END_ST = 1;
 
-    /// @define Value at which custom states in a derived class should begin.
+    /// @brief Value at which custom states in a derived class should begin.
     static const int SM_STATE_MAX = 10;
     //@}
 
@@ -264,7 +264,7 @@ public:
     /// @brief Event issued to abort the model execution.
     static const int FAIL_EVT = 3;
 
-    /// @define Value at which custom events in a derived class should begin.
+    /// @brief Value at which custom events in a derived class should begin.
     static const int SM_EVENT_MAX = 10;
     //@}
 
@@ -419,6 +419,8 @@ protected:
     /// @param value is the numeric value of the state
     /// @param label is the text label of the state used in log messages and
     /// exceptions.
+    /// @param handler is the bound instance method which implements the state's
+    /// actions.
     ///
     /// @throw StateModelError if the model has already been started, if
     /// the value is already defined, or if the label is empty.
@@ -512,7 +514,7 @@ protected:
     /// event that will be passed into the current state's handler on the next
     /// iteration of the run loop.
     ///
-    /// @param the numeric event value to post as the next event.
+    /// @param event the numeric event value to post as the next event.
     ///
     /// @throw StateModelError if the event is undefined
     void postNextEvent(unsigned int event);