master/fsm.c
branchstable-1.1
changeset 1717 cc1ee18207d3
parent 1716 9440f4ff25c7
child 1719 42ed27ae6785
--- a/master/fsm.c	Wed Aug 09 14:38:44 2006 +0000
+++ b/master/fsm.c	Wed Aug 09 15:04:07 2006 +0000
@@ -164,6 +164,10 @@
 
 /*****************************************************************************/
 
+/**
+   Initializes the master startup state machine.
+*/
+
 void ec_fsm_startup(ec_fsm_t *fsm)
 {
     fsm->master_state = ec_fsm_startup_start;
@@ -171,7 +175,12 @@
 
 /*****************************************************************************/
 
-int ec_fsm_startup_running(ec_fsm_t *fsm)
+/**
+   Returns the running state of the master startup state machine.
+   \return non-zero if not terminated yet.
+*/
+
+int ec_fsm_startup_running(ec_fsm_t *fsm /**< Finite state machine */)
 {
     return fsm->master_state != ec_fsm_end &&
         fsm->master_state != ec_fsm_error;
@@ -179,13 +188,22 @@
 
 /*****************************************************************************/
 
-int ec_fsm_startup_success(ec_fsm_t *fsm)
+/**
+   Returns, if the master startup state machine terminated with success.
+   \return non-zero if successful.
+*/
+
+int ec_fsm_startup_success(ec_fsm_t *fsm /**< Finite state machine */)
 {
     return fsm->master_state == ec_fsm_end;
 }
 
 /*****************************************************************************/
 
+/**
+   Initializes the master configuration state machine.
+*/
+
 void ec_fsm_configuration(ec_fsm_t *fsm)
 {
     fsm->master_state = ec_fsm_configuration_start;
@@ -193,7 +211,12 @@
 
 /*****************************************************************************/
 
-int ec_fsm_configuration_running(ec_fsm_t *fsm)
+/**
+   Returns the running state of the master configuration state machine.
+   \return non-zero if not terminated yet.
+*/
+
+int ec_fsm_configuration_running(ec_fsm_t *fsm /**< Finite state machine */)
 {
     return fsm->master_state != ec_fsm_end &&
         fsm->master_state != ec_fsm_error;
@@ -201,7 +224,12 @@
 
 /*****************************************************************************/
 
-int ec_fsm_configuration_success(ec_fsm_t *fsm)
+/**
+   Returns, if the master confuguration state machine terminated with success.
+   \return non-zero if successful.
+*/
+
+int ec_fsm_configuration_success(ec_fsm_t *fsm /**< Finite state machine */)
 {
     return fsm->master_state == ec_fsm_end;
 }
@@ -327,6 +355,10 @@
  *  master configuration state machine
  *****************************************************************************/
 
+/**
+   Master configuration state machine: START.
+*/
+
 void ec_fsm_configuration_start(ec_fsm_t *fsm /**< finite state machine */)
 {
     ec_master_t *master = fsm->master;