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

Timestamp:

05/11/11 10:27:33 (14 years ago)

Author:

tbretz

Message:

Added or improved documentation.

File:

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

trunk/FACT++/src/StateMachineImp.cc

@@ -295 +295 @@
 //!    size of the memory which should be attached to the event
 //!
+//! @returns
+//!    false if the event is ignored, true otherwise.
+//!
 //! @todo
 //!    - Shell we check for the validity of a command at the current state, too?
@@ -333 +336 @@
 //!    event should be for.
 //!
+//! @returns
+//!    false if the event is ignored, true otherwise.
+//!
 //! @todo
 //!    - Shell we check for the validity of a command at the current state, too?
@@ -357 +363 @@
 }
 
+// --------------------------------------------------------------------------
+//
+//! Return all event names of the StateMachine
+//!
+//! @returns
+//!    A vector of strings with all event names of the state machine.
+//!    The event names all have the SERVER/ pre-fix removed.
+//
 const vector<string> StateMachineImp::GetEventNames() const
 {
@@ -1010 +1024 @@
 //!    if functions are assigned directly to any event to simulate
 //!    a running loop (e.g. block until Stop() was called or fExitRequested
-//!    was set by an EXIT command.
+//!    was set by an EXIT command.  If dummy==true, fRunning is not set
+//!    to true to allow handling events directly from the event handler.
 //!
 //! @returns