Second time, Re-write doxygen tags in headers files to generate User API documentation

[CanFestival-3.git] / include / emcy.h

diff --git a/include/emcy.h b/include/emcy.h
index f3dacf2c1614b924f749d1eb0818c0bd597c4b3f..d3a19eb6d33596298450c57d109deb71f90236fd 100644 (file)
--- a/include/emcy.h
+++ b/include/emcy.h
@@ -29,7 +29,12 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 **
 **
 */
-
+ 
+/** @defgroup emcyo Emergency Object
+ *  Emergency Object is used to communicate device and application failures.
+ *  @ingroup comobj
+ */
+                                        
 #ifndef __emcy_h__
 #define __emcy_h__
 
@@ -52,31 +57,51 @@ typedef struct {
 #include "data.h"
 
 
-typedef void (*post_emcy_t)(UNS8 nodeID, UNS16 errCode, UNS8 errReg);
-void _post_emcy(UNS8 nodeID, UNS16 errCode, UNS8 errReg);
+typedef void (*post_emcy_t)(CO_Data* d, UNS8 nodeID, UNS16 errCode, UNS8 errReg);
+void _post_emcy(CO_Data* d, UNS8 nodeID, UNS16 errCode, UNS8 errReg);
 
 /*************************************************************************
  * 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);
+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);