include/emcy.h
changeset 528 0a30e161d63c
parent 378 d2abf6c8c27b
child 529 c171e11707c5
--- a/include/emcy.h	Thu Nov 20 07:51:14 2008 +0100
+++ b/include/emcy.h	Sat Jan 17 17:25:58 2009 +0100
@@ -29,7 +29,7 @@
 **
 **
 */
-
+ 
 #ifndef __emcy_h__
 #define __emcy_h__
 
@@ -59,24 +59,44 @@
  * Functions
  *************************************************************************/
 
-/** Sets a new error with code errCode. Also sets corresponding bits in Error register (1001h)
+/** 
+ * @ingroup emcy
+ * @brief Sets a new error with code errCode. Also sets corresponding bits in Error register (1001h)
+ * @param *d Pointer on a CAN object data structure
+ * @param errCode The error code
+ * @param errRegMask
+ * @param addInfo
+ * @return
  */
 UNS8 EMCY_setError(CO_Data* d, UNS16 errCode, UNS8 errRegMask, UNS16 addInfo);
 
-/** Indicates it has recovered from error errCode. Also clears corresponding bits in Error register (1001h)
+/**
+ * @ingroup emcy 
+ * @brief Indicates it has recovered from error errCode. Also clears corresponding bits in Error register (1001h)
+ * @param *d Pointer on a CAN object data structure
+ * @param errCode The error code
  */
 void EMCY_errorRecovered(CO_Data* d, UNS16 errCode);
 
-/** Start EMCY consumer and producer
+/**
+ * @ingroup emcy 
+ * @brief Start EMCY consumer and producer
+ * @param *d Pointer on a CAN object data structure
  */
 void emergencyInit(CO_Data* d);
 
-/** Stop EMCY producer and consumer 
+/** 
+ * @ingroup emcy
+ * @brief Stop EMCY producer and consumer
+ * @param *d Pointer on a CAN object data structure 
  */
 void emergencyStop(CO_Data* d);
 
-/** This function is responsible to process an EMCY canopen-message 
- *  \param Message The CAN-message which has to be analysed.
+/** 
+ * @ingroup emcy
+ * @brief This function is responsible to process an EMCY canopen-message
+ * @param *d Pointer on a CAN object data structure 
+ * @param *m Pointer on the CAN-message which has to be analysed.
  */
 void proceedEMCY(CO_Data* d, Message* m);