diff --git a/tasks/TaskFactory.h b/tasks/TaskFactory.h index 4fba345f5..7990a9cee 100644 --- a/tasks/TaskFactory.h +++ b/tasks/TaskFactory.h @@ -24,18 +24,21 @@ public: * @param name_ Name of the task * @param taskPriority_ * Priority of the task. This value might have different ranges for the various OSALs. - * Linux: Value ranging from 0 to 99 with 99 being the highest value. - * Host: Value can be retrieved by using the #tasks::makeWinPriority function. - * FreeRTOS: Value depends on the FreeRTOS configuration, higher number means higher priority - * RTEMS: Values ranging from 0 to 99 with 99 being the highest value. + * - Linux Value ranging from 0 to 99 with 99 being the highest value. + * - Host For Windows, the value can be retrieved by using the #tasks::makeWinPriority + * function. For Linux, same priority system as specified above. MacOS not tested + * yet + * - FreeRTOS Value depends on the FreeRTOS configuration, higher number means higher priority + * - RTEMS Values ranging from 0 to 99 with 99 being the highest value. * * @param stackSize_ Stack Size of the task * This value might have different recommended ranges for the various OSALs. - * Linux: Lowest limit is the PeriodicTaskIF::MINIMUM_STACK_SIZE value - * Host: Value is ignored for now because the C++ threading abstraction layer is used. - * FreeRTOS: Stack size in bytes. It is recommended to specify at least 1kB of stack for - * FSFW tasks, but the lowest possible size is specified in the FreeRTOSConfig.h file. - * RTEMS: Lowest limit is the PeriodicTaskIF::MINIMUM_STACK_SIZE value. + * - Linux Lowest limit is the PeriodicTaskIF::MINIMUM_STACK_SIZE value + * - Host Value is ignored for now because the C++ threading abstraction layer is used. + * - FreeRTOS Stack size in bytes. It is recommended to specify at least 1kB of stack for + * FSFW tasks, but the lowest possible size is specified in the + * FreeRTOSConfig.h file. + * - RTEMS Lowest limit is specified the PeriodicTaskIF::MINIMUM_STACK_SIZE value. * * @param period_ Period of the task *