[Gearbox-commit] SF.net SVN: gearbox:[347] gearbox/trunk/src/gbxutilacfr/status.h

[<rus...@us...>]

Revision: 347
          http://gearbox.svn.sourceforge.net/gearbox/?rev=347&view=rev
Author:   russo2503v
Date:     2008-10-27 13:02:07 +0000 (Mon, 27 Oct 2008)

Log Message:
-----------
typo

Modified Paths:
--------------
    gearbox/trunk/src/gbxutilacfr/status.h

Modified: gearbox/trunk/src/gbxutilacfr/status.h
===================================================================
--- gearbox/trunk/src/gbxutilacfr/status.h	2008-10-27 12:21:06 UTC (rev 346)
+++ gearbox/trunk/src/gbxutilacfr/status.h	2008-10-27 13:02:07 UTC (rev 347)
@@ -19,13 +19,19 @@
 //! Possible subsystem status values
 enum SubsystemState
 {
+    //! Subsystem has been created but has not started initialisation process.
     SubsystemIdle,
+    //! Subsystem is preparing to work, e.g. initialising its resources, etc.
     SubsystemInitialising,
+    //! Subsystem is fully initialised and is performing its function.
     SubsystemWorking,
+    //! Subsystem is preparing to shutdown, e.g. releasing its resources, etc.
     SubsystemFinalising,
+    //! Subsystem is not longer functioning.
     SubsystemShutdown
 };
 
+//! Returns string equivalent of state enumerator.
 std::string toString( SubsystemState state );
 
 //! Possible subsystem status values
@@ -41,14 +47,16 @@
     SubsystemStalled
 };
 
+//! Returns string equivalent of health enumerator.
 std::string toString( SubsystemHealth health );
 
 //! Status for a single subsystem
 struct SubsystemStatus
 {
-    //! Machine-readable status description
+    //! Current state in the subsystem's state machine. I.e. what is the subsystem doing?
     SubsystemState state;
 
+    //! Subsystem's health. I.e. how is the subsystem doing?
     SubsystemHealth health;
 
     //! Human-readable status description


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.