From 9b743249ecaee65ee439f3ba886c400c2ea2007d Mon Sep 17 00:00:00 2001 From: richardbarry Date: Sat, 13 Jul 2013 19:58:42 +0000 Subject: [PATCH] Update doxygen comments. git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@1978 1d2547de-c912-0410-9cb9-b8ca96c0e9e2 --- FreeRTOS/Source/include/queue.h | 4 ++-- FreeRTOS/Source/include/semphr.h | 2 +- FreeRTOS/Source/include/task.h | 24 ++++++++++++------------ FreeRTOS/Source/include/timers.h | 24 ++++++++++++++++-------- 4 files changed, 31 insertions(+), 23 deletions(-) diff --git a/FreeRTOS/Source/include/queue.h b/FreeRTOS/Source/include/queue.h index 84cdf1afb..d0d2e895f 100644 --- a/FreeRTOS/Source/include/queue.h +++ b/FreeRTOS/Source/include/queue.h @@ -928,7 +928,7 @@ signed portBASE_TYPE xQueueGenericReceive( xQueueHandle xQueue, void * const pvB * * @return The number of messages available in the queue. * - * \page uxQueueMessagesWaiting uxQueueMessagesWaiting + * \defgroup uxQueueMessagesWaiting uxQueueMessagesWaiting * \ingroup QueueManagement */ unsigned portBASE_TYPE uxQueueMessagesWaiting( const xQueueHandle xQueue ) PRIVILEGED_FUNCTION; @@ -942,7 +942,7 @@ unsigned portBASE_TYPE uxQueueMessagesWaiting( const xQueueHandle xQueue ) PRIVI * * @param xQueue A handle to the queue to be deleted. * - * \page vQueueDelete vQueueDelete + * \defgroup vQueueDelete vQueueDelete * \ingroup QueueManagement */ void vQueueDelete( xQueueHandle xQueue ) PRIVILEGED_FUNCTION; diff --git a/FreeRTOS/Source/include/semphr.h b/FreeRTOS/Source/include/semphr.h index 41aa2b17f..47721fa25 100644 --- a/FreeRTOS/Source/include/semphr.h +++ b/FreeRTOS/Source/include/semphr.h @@ -770,7 +770,7 @@ typedef xQueueHandle xSemaphoreHandle; * * @param xSemaphore A handle to the semaphore to be deleted. * - * \page vSemaphoreDelete vSemaphoreDelete + * \defgroup vSemaphoreDelete vSemaphoreDelete * \ingroup Semaphores */ #define vSemaphoreDelete( xSemaphore ) vQueueDelete( ( xQueueHandle ) ( xSemaphore ) ) diff --git a/FreeRTOS/Source/include/task.h b/FreeRTOS/Source/include/task.h index ec294438e..64b73e91b 100644 --- a/FreeRTOS/Source/include/task.h +++ b/FreeRTOS/Source/include/task.h @@ -100,7 +100,7 @@ extern "C" { * returns (via a pointer parameter) an xTaskHandle variable that can then * be used as a parameter to vTaskDelete to delete the task. * - * \page xTaskHandle xTaskHandle + * \defgroup xTaskHandle xTaskHandle * \ingroup Tasks */ typedef void * xTaskHandle; @@ -183,7 +183,7 @@ typedef enum * * Macro for forcing a context switch. * - * \page taskYIELD taskYIELD + * \defgroup taskYIELD taskYIELD * \ingroup SchedulerControl */ #define taskYIELD() portYIELD() @@ -197,7 +197,7 @@ typedef enum * NOTE: This may alter the stack (depending on the portable implementation) * so must be used with care! * - * \page taskENTER_CRITICAL taskENTER_CRITICAL + * \defgroup taskENTER_CRITICAL taskENTER_CRITICAL * \ingroup SchedulerControl */ #define taskENTER_CRITICAL() portENTER_CRITICAL() @@ -211,7 +211,7 @@ typedef enum * NOTE: This may alter the stack (depending on the portable implementation) * so must be used with care! * - * \page taskEXIT_CRITICAL taskEXIT_CRITICAL + * \defgroup taskEXIT_CRITICAL taskEXIT_CRITICAL * \ingroup SchedulerControl */ #define taskEXIT_CRITICAL() portEXIT_CRITICAL() @@ -221,7 +221,7 @@ typedef enum * * Macro to disable all maskable interrupts. * - * \page taskDISABLE_INTERRUPTS taskDISABLE_INTERRUPTS + * \defgroup taskDISABLE_INTERRUPTS taskDISABLE_INTERRUPTS * \ingroup SchedulerControl */ #define taskDISABLE_INTERRUPTS() portDISABLE_INTERRUPTS() @@ -231,7 +231,7 @@ typedef enum * * Macro to enable microcontroller interrupts. * - * \page taskENABLE_INTERRUPTS taskENABLE_INTERRUPTS + * \defgroup taskENABLE_INTERRUPTS taskENABLE_INTERRUPTS * \ingroup SchedulerControl */ #define taskENABLE_INTERRUPTS() portENABLE_INTERRUPTS() @@ -1036,7 +1036,7 @@ signed portBASE_TYPE xTaskIsTaskSuspended( xTaskHandle xTask ) PRIVILEGED_FUNCTI * * @return The count of ticks since vTaskStartScheduler was called. * - * \page xTaskGetTickCount xTaskGetTickCount + * \defgroup xTaskGetTickCount xTaskGetTickCount * \ingroup TaskUtils */ portTickType xTaskGetTickCount( void ) PRIVILEGED_FUNCTION; @@ -1052,7 +1052,7 @@ portTickType xTaskGetTickCount( void ) PRIVILEGED_FUNCTION; * microcontroller being used or interrupt nesting is either not supported or * not being used. * - * \page xTaskGetTickCount xTaskGetTickCount + * \defgroup xTaskGetTickCount xTaskGetTickCount * \ingroup TaskUtils */ portTickType xTaskGetTickCountFromISR( void ) PRIVILEGED_FUNCTION; @@ -1066,7 +1066,7 @@ portTickType xTaskGetTickCountFromISR( void ) PRIVILEGED_FUNCTION; * has been deleted but not yet freed by the idle task will also be * included in the count. * - * \page uxTaskGetNumberOfTasks uxTaskGetNumberOfTasks + * \defgroup uxTaskGetNumberOfTasks uxTaskGetNumberOfTasks * \ingroup TaskUtils */ unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void ) PRIVILEGED_FUNCTION; @@ -1080,7 +1080,7 @@ unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void ) PRIVILEGED_FUNCTION; * handle, or by setting xTaskToQuery to NULL. INCLUDE_pcTaskGetTaskName must be * set to 1 in FreeRTOSConfig.h for pcTaskGetTaskName() to be available. * - * \page pcTaskGetTaskName pcTaskGetTaskName + * \defgroup pcTaskGetTaskName pcTaskGetTaskName * \ingroup TaskUtils */ signed char *pcTaskGetTaskName( xTaskHandle xTaskToQuery ); @@ -1294,7 +1294,7 @@ unsigned portBASE_TYPE xTaskGetSystemState( xTaskStatusType *pxTaskStatusArray, * enough to contain the generated report. Approximately 40 bytes per * task should be sufficient. * - * \page vTaskList vTaskList + * \defgroup vTaskList vTaskList * \ingroup TaskUtils */ void vTaskList( signed char *pcWriteBuffer ) PRIVILEGED_FUNCTION; @@ -1348,7 +1348,7 @@ void vTaskList( signed char *pcWriteBuffer ) PRIVILEGED_FUNCTION; * contain the generated report. Approximately 40 bytes per task should * be sufficient. * - * \page vTaskGetRunTimeStats vTaskGetRunTimeStats + * \defgroup vTaskGetRunTimeStats vTaskGetRunTimeStats * \ingroup TaskUtils */ void vTaskGetRunTimeStats( signed char *pcWriteBuffer ) PRIVILEGED_FUNCTION; diff --git a/FreeRTOS/Source/include/timers.h b/FreeRTOS/Source/include/timers.h index 21b90f263..95669d43c 100644 --- a/FreeRTOS/Source/include/timers.h +++ b/FreeRTOS/Source/include/timers.h @@ -158,7 +158,7 @@ typedef void (*tmrTIMER_CALLBACK)( xTimerHandle xTimer ); * structures, or the timer period was set to 0) then 0 is returned. * * Example usage: - * + * @verbatim * #define NUM_TIMERS 5 * * // An array to hold handles to the created timers. @@ -237,6 +237,7 @@ typedef void (*tmrTIMER_CALLBACK)( xTimerHandle xTimer ); * // Should not reach here. * for( ;; ); * } + * @endverbatim */ xTimerHandle xTimerCreate( const signed char * const pcTimerName, portTickType xTimerPeriodInTicks, unsigned portBASE_TYPE uxAutoReload, void * pvTimerID, tmrTIMER_CALLBACK pxCallbackFunction ) PRIVILEGED_FUNCTION; @@ -282,7 +283,7 @@ void *pvTimerGetTimerID( xTimerHandle xTimer ) PRIVILEGED_FUNCTION; * pdFALSE will be returned if the timer is active. * * Example usage: - * + * @verbatim * // This function assumes xTimer has already been created. * void vAFunction( xTimerHandle xTimer ) * { @@ -295,6 +296,7 @@ void *pvTimerGetTimerID( xTimerHandle xTimer ) PRIVILEGED_FUNCTION; * // xTimer is not active, do something else. * } * } + * @endverbatim */ portBASE_TYPE xTimerIsTimerActive( xTimerHandle xTimer ) PRIVILEGED_FUNCTION; @@ -447,7 +449,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void ); * configTIMER_TASK_PRIORITY configuration constant. * * Example usage: - * + * @verbatim * // This function assumes xTimer has already been created. If the timer * // referenced by xTimer is already active when it is called, then the timer * // is deleted. If the timer referenced by xTimer is not active when it is @@ -477,6 +479,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void ); * } * } * } + * @endverbatim */ #define xTimerChangePeriod( xTimer, xNewPeriod, xBlockTime ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_CHANGE_PERIOD, ( xNewPeriod ), NULL, ( xBlockTime ) ) @@ -566,7 +569,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void ); * configuration constant. * * Example usage: - * + * @verbatim * // When a key is pressed, an LCD back-light is switched on. If 5 seconds pass * // without a key being pressed, then the LCD back-light is switched off. In * // this case, the timer is a one-shot timer. @@ -638,6 +641,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void ); * // Should not reach here. * for( ;; ); * } + * @endverbatim */ #define xTimerReset( xTimer, xBlockTime ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_START, ( xTaskGetTickCount() ), NULL, ( xBlockTime ) ) @@ -671,7 +675,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void ); * task priority is set by the configTIMER_TASK_PRIORITY configuration constant. * * Example usage: - * + * @verbatim * // This scenario assumes xBacklightTimer has already been created. When a * // key is pressed, an LCD back-light is switched on. If 5 seconds pass * // without a key being pressed, then the LCD back-light is switched off. In @@ -722,6 +726,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void ); * // depends on the FreeRTOS port being used. * } * } + * @endverbatim */ #define xTimerStartFromISR( xTimer, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_START, ( xTaskGetTickCountFromISR() ), ( pxHigherPriorityTaskWoken ), 0U ) @@ -754,7 +759,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void ); * priority is set by the configTIMER_TASK_PRIORITY configuration constant. * * Example usage: - * + * @verbatim * // This scenario assumes xTimer has already been created and started. When * // an interrupt occurs, the timer should be simply stopped. * @@ -784,6 +789,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void ); * // depends on the FreeRTOS port being used. * } * } + * @endverbatim */ #define xTimerStopFromISR( xTimer, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_STOP, 0, ( pxHigherPriorityTaskWoken ), 0U ) @@ -826,7 +832,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void ); * priority is set by the configTIMER_TASK_PRIORITY configuration constant. * * Example usage: - * + * @verbatim * // This scenario assumes xTimer has already been created and started. When * // an interrupt occurs, the period of xTimer should be changed to 500ms. * @@ -856,6 +862,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void ); * // depends on the FreeRTOS port being used. * } * } + * @endverbatim */ #define xTimerChangePeriodFromISR( xTimer, xNewPeriod, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_CHANGE_PERIOD, ( xNewPeriod ), ( pxHigherPriorityTaskWoken ), 0U ) @@ -890,7 +897,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void ); * task priority is set by the configTIMER_TASK_PRIORITY configuration constant. * * Example usage: - * + * @verbatim * // This scenario assumes xBacklightTimer has already been created. When a * // key is pressed, an LCD back-light is switched on. If 5 seconds pass * // without a key being pressed, then the LCD back-light is switched off. In @@ -941,6 +948,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void ); * // depends on the FreeRTOS port being used. * } * } + * @endverbatim */ #define xTimerResetFromISR( xTimer, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_START, ( xTaskGetTickCountFromISR() ), ( pxHigherPriorityTaskWoken ), 0U ) -- 2.39.5