diff --git a/osal/FreeRTOS/PeriodicTask.h b/osal/FreeRTOS/PeriodicTask.h index 4ece20b3..a449328e 100644 --- a/osal/FreeRTOS/PeriodicTask.h +++ b/osal/FreeRTOS/PeriodicTask.h @@ -1,5 +1,5 @@ -#ifndef PERIODICTASK_H_ -#define PERIODICTASK_H_ +#ifndef FRAMEWORK_OSAL_FREERTOS_PERIODICTASK_H_ +#define FRAMEWORK_OSAL_FREERTOS_PERIODICTASK_H_ #include #include @@ -17,8 +17,6 @@ class ExecutableObjectIF; /** * @brief This class represents a specialized task for * periodic activities of multiple objects. - * @details - * * @ingroup task_handling */ class PeriodicTask: public PeriodicTaskIF { @@ -26,24 +24,25 @@ public: /** * @brief Standard constructor of the class. * @details - * The class is initialized without allocated objects. These need to be added - * with #addComponent. In the underlying TaskBase class, a new operating - * system task is created. In addition to the TaskBase parameters, - * the period, the pointer to the aforementioned initialization function and - * an optional "deadline-missed" function pointer is passed. - * @param priority Sets the priority of a task. Values depend on - * freeRTOS configuration, high number means high priority. - * @param stack_size The stack size reserved by the operating system for the task. - * @param setPeriod The length of the period with which the task's + * The class is initialized without allocated objects. + * These need to be added with #addComponent. + * @param priority + * Sets the priority of a task. Values depend on freeRTOS configuration, + * high number means high priority. + * @param stack_size + * The stack size reserved by the operating system for the task. + * @param setPeriod + * The length of the period with which the task's * functionality will be executed. It is expressed in clock ticks. * @param setDeadlineMissedFunc - * The function pointer to the deadline missed function that shall be assigned. + * The function pointer to the deadline missed function that shall + * be assigned. */ PeriodicTask(const char *name, TaskPriority setPriority, TaskStackSize setStack, TaskPeriod setPeriod,void (*setDeadlineMissedFunc)()); /** - * @brief Currently, the executed object's lifetime is not coupled with the task object's - * lifetime, so the destructor is empty. + * @brief Currently, the executed object's lifetime is not coupled with + * the task object's lifetime, so the destructor is empty. */ virtual ~PeriodicTask(void);