include/lifegrd.h
changeset 529 c171e11707c5
parent 528 0a30e161d63c
child 635 30a0e926bb2e
--- a/include/lifegrd.h	Sat Jan 17 17:25:58 2009 +0100
+++ b/include/lifegrd.h	Mon Jan 19 10:27:58 2009 +0100
@@ -20,6 +20,14 @@
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
+/** @defgroup heartbeato Heartbeat Object
+ *  The heartbeat mechanism for a device is established through cyclically transmitting a message by a
+ *	heartbeat producer. One or more devices in the network are aware of this heartbeat message. If the
+ *	heartbeat cycle fails for the heartbeat producer the local application on the heartbeat consumer will be
+ *	informed about that event.
+ *  @ingroup comobj
+ */
+					 
 #ifndef __lifegrd_h__
 #define __lifegrd_h__
 
@@ -39,6 +47,7 @@
  *************************************************************************/
 
 /** 
+ * @ingroup statemachine
  * @brief To read the state of a node
  * This can be used by the master after having sent a life guard request,
  * of by any node if it is waiting for heartbeat.