Update doxygen comments.

git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@1978 1d2547de-c912-0410-9cb9-b8ca96c0e9e2

diff --git a/FreeRTOS/Source/include/queue.h b/FreeRTOS/Source/include/queue.h
index 84cdf1afb9f815e366c85654cb66b852611775fa..d0d2e895fe54db4e46ccca4be79dada8ec9db377 100644 (file)
--- 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
  *\r
  * @return The number of messages available in the queue.\r
  *\r
- * \page uxQueueMessagesWaiting uxQueueMessagesWaiting\r
+ * \defgroup uxQueueMessagesWaiting uxQueueMessagesWaiting\r
  * \ingroup QueueManagement\r
  */\r
 unsigned portBASE_TYPE uxQueueMessagesWaiting( const xQueueHandle xQueue ) PRIVILEGED_FUNCTION;\r
@@ -942,7 +942,7 @@ unsigned portBASE_TYPE uxQueueMessagesWaiting( const xQueueHandle xQueue ) PRIVI
  *\r
  * @param xQueue A handle to the queue to be deleted.\r
  *\r
- * \page vQueueDelete vQueueDelete\r
+ * \defgroup vQueueDelete vQueueDelete\r
  * \ingroup QueueManagement\r
  */\r
 void vQueueDelete( xQueueHandle xQueue ) PRIVILEGED_FUNCTION;\r

diff --git a/FreeRTOS/Source/include/semphr.h b/FreeRTOS/Source/include/semphr.h
index 41aa2b17f115505988a2ca7cfc9374b3515b3f63..47721fa25ed8e0eb00a31fae8caffe2d9f55ae13 100644 (file)
--- a/FreeRTOS/Source/include/semphr.h
+++ b/FreeRTOS/Source/include/semphr.h
@@ -770,7 +770,7 @@ typedef xQueueHandle xSemaphoreHandle;
  *\r
  * @param xSemaphore A handle to the semaphore to be deleted.\r
  *\r
- * \page vSemaphoreDelete vSemaphoreDelete\r
+ * \defgroup vSemaphoreDelete vSemaphoreDelete\r
  * \ingroup Semaphores\r
  */\r
 #define vSemaphoreDelete( xSemaphore ) vQueueDelete( ( xQueueHandle ) ( xSemaphore ) )\r

diff --git a/FreeRTOS/Source/include/task.h b/FreeRTOS/Source/include/task.h
index ec294438ec6b538ff93b809d66000a0dee48ba2f..64b73e91b115a17fa07b9fe1c8584ef8ebbffb3a 100644 (file)
--- 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\r
  * be used as a parameter to vTaskDelete to delete the task.\r
  *\r
- * \page xTaskHandle xTaskHandle\r
+ * \defgroup xTaskHandle xTaskHandle\r
  * \ingroup Tasks\r
  */\r
 typedef void * xTaskHandle;\r
@@ -183,7 +183,7 @@ typedef enum
  *\r
  * Macro for forcing a context switch.\r
  *\r
- * \page taskYIELD taskYIELD\r
+ * \defgroup taskYIELD taskYIELD\r
  * \ingroup SchedulerControl\r
  */\r
 #define taskYIELD()                                    portYIELD()\r
@@ -197,7 +197,7 @@ typedef enum
  * NOTE: This may alter the stack (depending on the portable implementation)\r
  * so must be used with care!\r
  *\r
- * \page taskENTER_CRITICAL taskENTER_CRITICAL\r
+ * \defgroup taskENTER_CRITICAL taskENTER_CRITICAL\r
  * \ingroup SchedulerControl\r
  */\r
 #define taskENTER_CRITICAL()           portENTER_CRITICAL()\r
@@ -211,7 +211,7 @@ typedef enum
  * NOTE: This may alter the stack (depending on the portable implementation)\r
  * so must be used with care!\r
  *\r
- * \page taskEXIT_CRITICAL taskEXIT_CRITICAL\r
+ * \defgroup taskEXIT_CRITICAL taskEXIT_CRITICAL\r
  * \ingroup SchedulerControl\r
  */\r
 #define taskEXIT_CRITICAL()                    portEXIT_CRITICAL()\r
@@ -221,7 +221,7 @@ typedef enum
  *\r
  * Macro to disable all maskable interrupts.\r
  *\r
- * \page taskDISABLE_INTERRUPTS taskDISABLE_INTERRUPTS\r
+ * \defgroup taskDISABLE_INTERRUPTS taskDISABLE_INTERRUPTS\r
  * \ingroup SchedulerControl\r
  */\r
 #define taskDISABLE_INTERRUPTS()       portDISABLE_INTERRUPTS()\r
@@ -231,7 +231,7 @@ typedef enum
  *\r
  * Macro to enable microcontroller interrupts.\r
  *\r
- * \page taskENABLE_INTERRUPTS taskENABLE_INTERRUPTS\r
+ * \defgroup taskENABLE_INTERRUPTS taskENABLE_INTERRUPTS\r
  * \ingroup SchedulerControl\r
  */\r
 #define taskENABLE_INTERRUPTS()                portENABLE_INTERRUPTS()\r
@@ -1036,7 +1036,7 @@ signed portBASE_TYPE xTaskIsTaskSuspended( xTaskHandle xTask ) PRIVILEGED_FUNCTI
  *\r
  * @return The count of ticks since vTaskStartScheduler was called.\r
  *\r
- * \page xTaskGetTickCount xTaskGetTickCount\r
+ * \defgroup xTaskGetTickCount xTaskGetTickCount\r
  * \ingroup TaskUtils\r
  */\r
 portTickType xTaskGetTickCount( void ) PRIVILEGED_FUNCTION;\r
@@ -1052,7 +1052,7 @@ portTickType xTaskGetTickCount( void ) PRIVILEGED_FUNCTION;
  * microcontroller being used or interrupt nesting is either not supported or\r
  * not being used.\r
  *\r
- * \page xTaskGetTickCount xTaskGetTickCount\r
+ * \defgroup xTaskGetTickCount xTaskGetTickCount\r
  * \ingroup TaskUtils\r
  */\r
 portTickType xTaskGetTickCountFromISR( void ) PRIVILEGED_FUNCTION;\r
@@ -1066,7 +1066,7 @@ portTickType xTaskGetTickCountFromISR( void ) PRIVILEGED_FUNCTION;
  * has been deleted but not yet freed by the idle task will also be\r
  * included in the count.\r
  *\r
- * \page uxTaskGetNumberOfTasks uxTaskGetNumberOfTasks\r
+ * \defgroup uxTaskGetNumberOfTasks uxTaskGetNumberOfTasks\r
  * \ingroup TaskUtils\r
  */\r
 unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void ) PRIVILEGED_FUNCTION;\r
@@ -1080,7 +1080,7 @@ unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void ) PRIVILEGED_FUNCTION;
  * handle, or by setting xTaskToQuery to NULL.  INCLUDE_pcTaskGetTaskName must be\r
  * set to 1 in FreeRTOSConfig.h for pcTaskGetTaskName() to be available.\r
  *\r
- * \page pcTaskGetTaskName pcTaskGetTaskName\r
+ * \defgroup pcTaskGetTaskName pcTaskGetTaskName\r
  * \ingroup TaskUtils\r
  */\r
 signed char *pcTaskGetTaskName( xTaskHandle xTaskToQuery );\r
@@ -1294,7 +1294,7 @@ unsigned portBASE_TYPE xTaskGetSystemState( xTaskStatusType *pxTaskStatusArray,
  * enough to contain the generated report.  Approximately 40 bytes per\r
  * task should be sufficient.\r
  *\r
- * \page vTaskList vTaskList\r
+ * \defgroup vTaskList vTaskList\r
  * \ingroup TaskUtils\r
  */\r
 void vTaskList( signed char *pcWriteBuffer ) PRIVILEGED_FUNCTION;\r
@@ -1348,7 +1348,7 @@ void vTaskList( signed char *pcWriteBuffer ) PRIVILEGED_FUNCTION;
  * contain the generated report.  Approximately 40 bytes per task should\r
  * be sufficient.\r
  *\r
- * \page vTaskGetRunTimeStats vTaskGetRunTimeStats\r
+ * \defgroup vTaskGetRunTimeStats vTaskGetRunTimeStats\r
  * \ingroup TaskUtils\r
  */\r
 void vTaskGetRunTimeStats( signed char *pcWriteBuffer ) PRIVILEGED_FUNCTION;\r

diff --git a/FreeRTOS/Source/include/timers.h b/FreeRTOS/Source/include/timers.h
index 21b90f263fe323f932ddd690b35e0fbcef201f38..95669d43cb8505e310f8808fd2faadc9102346c3 100644 (file)
--- 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.\r
  *\r
  * Example usage:\r
- *\r
+ * @verbatim\r
  * #define NUM_TIMERS 5\r
  *\r
  * // An array to hold handles to the created timers.\r
@@ -237,6 +237,7 @@ typedef void (*tmrTIMER_CALLBACK)( xTimerHandle xTimer );
  *     // Should not reach here.\r
  *     for( ;; );\r
  * }\r
+ * @endverbatim\r
  */\r
 xTimerHandle xTimerCreate( const signed char * const pcTimerName, portTickType xTimerPeriodInTicks, unsigned portBASE_TYPE uxAutoReload, void * pvTimerID, tmrTIMER_CALLBACK pxCallbackFunction ) PRIVILEGED_FUNCTION;\r
 \r
@@ -282,7 +283,7 @@ void *pvTimerGetTimerID( xTimerHandle xTimer ) PRIVILEGED_FUNCTION;
  * pdFALSE will be returned if the timer is active.\r
  *\r
  * Example usage:\r
- *\r
+ * @verbatim\r
  * // This function assumes xTimer has already been created.\r
  * void vAFunction( xTimerHandle xTimer )\r
  * {\r
@@ -295,6 +296,7 @@ void *pvTimerGetTimerID( xTimerHandle xTimer ) PRIVILEGED_FUNCTION;
  *         // xTimer is not active, do something else.\r
  *     }\r
  * }\r
+ * @endverbatim\r
  */\r
 portBASE_TYPE xTimerIsTimerActive( xTimerHandle xTimer ) PRIVILEGED_FUNCTION;\r
 \r
@@ -447,7 +449,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void );
  * configTIMER_TASK_PRIORITY configuration constant.\r
  *\r
  * Example usage:\r
- *\r
+ * @verbatim\r
  * // This function assumes xTimer has already been created.  If the timer\r
  * // referenced by xTimer is already active when it is called, then the timer\r
  * // is deleted.  If the timer referenced by xTimer is not active when it is\r
@@ -477,6 +479,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void );
  *         }\r
  *     }\r
  * }\r
+ * @endverbatim\r
  */\r
  #define xTimerChangePeriod( xTimer, xNewPeriod, xBlockTime ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_CHANGE_PERIOD, ( xNewPeriod ), NULL, ( xBlockTime ) )\r
 \r
@@ -566,7 +569,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void );
  * configuration constant.\r
  *\r
  * Example usage:\r
- *\r
+ * @verbatim\r
  * // When a key is pressed, an LCD back-light is switched on.  If 5 seconds pass\r
  * // without a key being pressed, then the LCD back-light is switched off.  In\r
  * // this case, the timer is a one-shot timer.\r
@@ -638,6 +641,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void );
  *     // Should not reach here.\r
  *     for( ;; );\r
  * }\r
+ * @endverbatim\r
  */\r
 #define xTimerReset( xTimer, xBlockTime ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_START, ( xTaskGetTickCount() ), NULL, ( xBlockTime ) )\r
 \r
@@ -671,7 +675,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void );
  * task priority is set by the configTIMER_TASK_PRIORITY configuration constant.\r
  *\r
  * Example usage:\r
- *\r
+ * @verbatim\r
  * // This scenario assumes xBacklightTimer has already been created.  When a\r
  * // key is pressed, an LCD back-light is switched on.  If 5 seconds pass\r
  * // without a key being pressed, then the LCD back-light is switched off.  In\r
@@ -722,6 +726,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void );
  *         // depends on the FreeRTOS port being used.\r
  *     }\r
  * }\r
+ * @endverbatim\r
  */\r
 #define xTimerStartFromISR( xTimer, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_START, ( xTaskGetTickCountFromISR() ), ( pxHigherPriorityTaskWoken ), 0U )\r
 \r
@@ -754,7 +759,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void );
  * priority is set by the configTIMER_TASK_PRIORITY configuration constant.\r
  *\r
  * Example usage:\r
- *\r
+ * @verbatim\r
  * // This scenario assumes xTimer has already been created and started.  When\r
  * // an interrupt occurs, the timer should be simply stopped.\r
  *\r
@@ -784,6 +789,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void );
  *         // depends on the FreeRTOS port being used.\r
  *     }\r
  * }\r
+ * @endverbatim\r
  */\r
 #define xTimerStopFromISR( xTimer, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_STOP, 0, ( pxHigherPriorityTaskWoken ), 0U )\r
 \r
@@ -826,7 +832,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void );
  * priority is set by the configTIMER_TASK_PRIORITY configuration constant.\r
  *\r
  * Example usage:\r
- *\r
+ * @verbatim\r
  * // This scenario assumes xTimer has already been created and started.  When\r
  * // an interrupt occurs, the period of xTimer should be changed to 500ms.\r
  *\r
@@ -856,6 +862,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void );
  *         // depends on the FreeRTOS port being used.\r
  *     }\r
  * }\r
+ * @endverbatim\r
  */\r
 #define xTimerChangePeriodFromISR( xTimer, xNewPeriod, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_CHANGE_PERIOD, ( xNewPeriod ), ( pxHigherPriorityTaskWoken ), 0U )\r
 \r
@@ -890,7 +897,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void );
  * task priority is set by the configTIMER_TASK_PRIORITY configuration constant.\r
  *\r
  * Example usage:\r
- *\r
+ * @verbatim\r
  * // This scenario assumes xBacklightTimer has already been created.  When a\r
  * // key is pressed, an LCD back-light is switched on.  If 5 seconds pass\r
  * // without a key being pressed, then the LCD back-light is switched off.  In\r
@@ -941,6 +948,7 @@ xTaskHandle xTimerGetTimerDaemonTaskHandle( void );
  *         // depends on the FreeRTOS port being used.\r
  *     }\r
  * }\r
+ * @endverbatim\r
  */\r
 #define xTimerResetFromISR( xTimer, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_START, ( xTaskGetTickCountFromISR() ), ( pxHigherPriorityTaskWoken ), 0U )\r
 \r