Changeset 10300 for trunk/FACT++/src/StateMachineImp.cc

Timestamp:

04/07/11 12:40:40 (14 years ago)

Author:

tbretz

Message:

Fixed typo in function name.

File:

• trunk/FACT++/src/StateMachineImp.cc (modified) (2 diffs)

trunk/FACT++/src/StateMachineImp.cc

@@ -646 +646 @@
 //!
 //! @returns
-//!    The state name as stored in fStateName is returned corresponding
+//!    The state name as stored in fStateNames is returned, corresponding
 //!    to the state given. If no name exists the number is returned
 //!    as string.
@@ -656 +656 @@
 }
 
-const string StateMachineImp::GetStateDoc(int state) /*const*/
+// --------------------------------------------------------------------------
+//
+//! @param state
+//!    The state for which the name should be returned.
+//!
+//! @returns
+//!    The description of a state name as stored in fStateNames is returned,
+//!    corresponding to the state given. If no name exists an empty string is
+//!    returned.
+//!
+const string StateMachineImp::GetStateDesc(int state) /*const*/
 {
     return fStateNames[state].second;
 }
-
 
 // --------------------------------------------------------------------------