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

[CanFestival-3.git] / include / unix / canfestival.h

diff --git a/include/unix/canfestival.h b/include/unix/canfestival.h
index c5ab67c07613b69f6ac924a531b20f990ed438d1..c403b55f8136a95885828e714406e9be7895ec24 100644 (file)
--- a/include/unix/canfestival.h
+++ b/include/unix/canfestival.h
@@ -16,12 +16,69 @@ extern "C" {
 
 typedef void* LIB_HANDLE;
 
+/** @defgroup userapi User API */
+
+/** @defgroup can CAN management
+ *  @ingroup userapi
+ */
+
+/**
+ * @ingroup can
+ * @{
+ */
+
+/**
+ * @ingroup can
+ * @brief Unload CAN driver interface
+ * @param handle The library handle
+ * @return 0 if succes
+ */
 UNS8 UnLoadCanDriver(LIB_HANDLE handle);
+
+/**
+ * @ingroup can
+ * @brief Load CAN driver interface
+ * @param *driver_name The location of the library to load
+ * @return handle The library handle
+ */
 LIB_HANDLE LoadCanDriver(const char* driver_name);
+
+/**
+ * @ingroup can
+ * @brief Send a CAN message
+ * @param port CanFestival file descriptor
+ * @param *m The message to send
+ * @return 0 if succes
+ */
 UNS8 canSend(CAN_PORT port, Message *m);
+
+/**
+ * @ingroup can
+ * @brief Open a CANopen device
+ * @param *board Pointer on the board structure that contains busname and baudrate 
+ * @param *d Pointer on the CAN object data structure
+ * @return port CanFestival file descriptor
+ */
 CAN_PORT canOpen(s_BOARD *board, CO_Data * d);
+
+/**
+ * @ingroup can
+ * @brief Stop the timer task
+ * @param *d Pointer on the CAN object data structure
+ * @return 0 if succes
+ */
 int canClose(CO_Data * d);
+
+/**
+ * @ingroup can
+ * @brief Stop the timer task
+ * @param port CanFestival file descriptor 
+ * @param *baud The new baudrate to assign
+ * @return 0 if succes
+ */
 UNS8 canChangeBaudRate(CAN_PORT port, char* baud);
+/** @} */
+
 
 #ifdef __cplusplus
 };