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

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

diff --git a/include/timers_driver.h b/include/timers_driver.h
index 0560ab36ed4fb047cd0537268b6169b1d2209673..5b41121b8ba33c7d9cc4a0add190ff94e6bd62c6 100644 (file)
--- a/include/timers_driver.h
+++ b/include/timers_driver.h
@@ -20,20 +20,64 @@ License along with this library; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 
+/** @defgroup timer Timer Management
+ *  @ingroup userapi
+ */
+
 #ifndef __timer_driver_h__
 #define __timer_driver_h__
 
+#include "timerscfg.h"
 #include "timer.h"
-/*void initTimer();*/
 
 // For use from CAN driver
+/**
+ * @ingroup timer
+ * @brief Acquire mutex
+ */
 void EnterMutex(void);
+
+/**
+ * @ingroup timer
+ * @brief Release mutex
+ */
 void LeaveMutex(void);
 void WaitReceiveTaskEnd(TASK_HANDLE*);
-void stopTimer(void);
 
-// For use from application
-void TimerLoop(TimerCallback_t init_callback);
-void CreateReceiveTask(CAN_HANDLE fd0, TASK_HANDLE *ReceiveLoop_task);
+/**
+ * @ingroup timer
+ * @brief Initialize Timer 
+ * 
+ */
+void TimerInit(void);
+
+/**
+ * @ingroup timer
+ * @brief Cleanup Timer  
+ */
+void TimerCleanup(void);
+
+/**
+ * @ingroup timer
+ * @brief Start the timer task
+ * @param Callback A callback function
+ */
+void StartTimerLoop(TimerCallback_t Callback);
+
+/**
+ * @ingroup timer
+ * @brief Stop the timer task
+ * @param Callback A callback function
+ */
+void StopTimerLoop(TimerCallback_t Callback);
+/** @} */
+
+/**
+ * @brief Stop the timer task
+ * @param port CanFestival file descriptor
+ * @param *handle handle of receive loop thread
+ * @param *ReceiveLoopPtr Pointer on the receive loop function
+ */
+void CreateReceiveTask(CAN_PORT port, TASK_HANDLE* handle, void* ReceiveLoopPtr);
 
 #endif