Merge branch 'zim-fix-defines-in-doc' into 'master'

freertos: fix defines in documentation

See merge request espressif/esp-idf!14987

components/freertos/include/freertos/event_groups.h

@@ -268,8 +268,8 @@ typedef TickType_t               EventBits_t;
  *
  * Example usage:
  * @code{c}
- * \#define BIT_0 ( 1 << 0 )
- * \#define BIT_4 ( 1 << 4 )
+ * #define BIT_0 ( 1 << 0 )
+ * #define BIT_4 ( 1 << 4 )
  *
  * void aFunction( EventGroupHandle_t xEventGroup )
  * {
@@ -336,8 +336,8 @@ EventBits_t xEventGroupWaitBits( EventGroupHandle_t xEventGroup,
  *
  * Example usage:
  * @code{c}
- * \#define BIT_0 ( 1 << 0 )
- * \#define BIT_4 ( 1 << 4 )
+ * #define BIT_0 ( 1 << 0 )
+ * #define BIT_4 ( 1 << 4 )
  *
  * void aFunction( EventGroupHandle_t xEventGroup )
  * {
@@ -409,8 +409,8 @@ EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup,
  *
  * Example usage:
  * @code{c}
- *    \#define BIT_0 ( 1 << 0 )
- *    \#define BIT_4 ( 1 << 4 )
+ * #define BIT_0 ( 1 << 0 )
+ * #define BIT_4 ( 1 << 4 )
  *
  * // An event group which it is assumed has already been created by a call to
  * // xEventGroupCreate().
@@ -475,8 +475,8 @@ EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup,
  *
  * Example usage:
  * @code{c}
- *    \#define BIT_0 ( 1 << 0 )
- *    \#define BIT_4 ( 1 << 4 )
+ * #define BIT_0 ( 1 << 0 )
+ * #define BIT_4 ( 1 << 4 )
  *
  * void aFunction( EventGroupHandle_t xEventGroup )
  * {
@@ -561,8 +561,8 @@ EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup,
  *
  * Example usage:
  * @code{c}
- * \#define BIT_0 ( 1 << 0 )
- * \#define BIT_4 ( 1 << 4 )
+ * #define BIT_0 ( 1 << 0 )
+ * #define BIT_4 ( 1 << 4 )
  *
  * // An event group which it is assumed has already been created by a call to
  * // xEventGroupCreate().
@@ -656,11 +656,11 @@ EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup,
  * Example usage:
  * @code{c}
  * // Bits used by the three tasks.
- * \#define TASK_0_BIT      ( 1 << 0 )
- * \#define TASK_1_BIT      ( 1 << 1 )
- * \#define TASK_2_BIT      ( 1 << 2 )
+ * #define TASK_0_BIT      ( 1 << 0 )
+ * #define TASK_1_BIT      ( 1 << 1 )
+ * #define TASK_2_BIT      ( 1 << 2 )
  *
- * \#define ALL_SYNC_BITS ( TASK_0_BIT | TASK_1_BIT | TASK_2_BIT )
+ * #define ALL_SYNC_BITS ( TASK_0_BIT | TASK_1_BIT | TASK_2_BIT )
  *
  * // Use an event group to synchronise three tasks.  It is assumed this event
  * // group has already been created elsewhere.

components/freertos/include/freertos/message_buffer.h

@@ -185,7 +185,7 @@ typedef void * MessageBufferHandle_t;
  *
  * // Used to dimension the array used to hold the messages.  The available space
  * // will actually be one less than this, so 999.
- * \#define STORAGE_SIZE_BYTES 1000
+ * #define STORAGE_SIZE_BYTES 1000
  *
  * // Defines the memory that will actually hold the messages within the message
  * // buffer.

components/freertos/include/freertos/queue.h

@@ -187,8 +187,8 @@ typedef struct QueueDefinition   * QueueSetMemberHandle_t;
  *  char ucData[ 20 ];
  * };
  *
- * \#define QUEUE_LENGTH 10
- * \#define ITEM_SIZE sizeof( uint32_t )
+ * #define QUEUE_LENGTH 10
+ * #define ITEM_SIZE sizeof( uint32_t )
  *
  * // xQueueBuffer will hold the queue structure.
  * StaticQueue_t xQueueBuffer;

components/freertos/include/freertos/semphr.h

@@ -607,8 +607,8 @@ typedef QueueHandle_t SemaphoreHandle_t;
  *
  * Example usage:
  * @code{c}
- *  \#define LONG_TIME 0xffff
- *  \#define TICKS_TO_WAIT  10
+ * #define LONG_TIME 0xffff
+ * #define TICKS_TO_WAIT  10
  * SemaphoreHandle_t xSemaphore = NULL;
  *
  * // Repetitive task.

components/freertos/include/freertos/stream_buffer.h

@@ -193,7 +193,7 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
  *
  * // Used to dimension the array used to hold the streams.  The available space
  * // will actually be one less than this, so 999.
- * \#define STORAGE_SIZE_BYTES 1000
+ * #define STORAGE_SIZE_BYTES 1000
  *
  * // Defines the memory that will actually hold the streams within the stream
  * // buffer.

components/freertos/include/freertos/task.h

@@ -521,7 +521,7 @@ typedef enum
  *  // Dimensions the buffer that the task being created will use as its stack.
  *  // NOTE:  This is the number of bytes the stack will hold, not the number of
  *  // words as found in vanilla FreeRTOS.
- * \#define STACK_SIZE 200
+ * #define STACK_SIZE 200
  *
  *  // Structure that will hold the TCB of the task being created.
  *  StaticTask_t xTaskBuffer;