Skip to content

[DOC] Some minor mistakes of code comment #1366

@wirelinker

Description

@wirelinker

Describe the issue
I found some minor mistakes when reading the code. So I made a collection for them.

Reference

  • pulPreviousNotificationValue should be indicated as @param.

    * pulPreviousNotificationValue -

  • Missing description of pulPreviousNotificationValue in the comment above for xTaskGenericNotifyFromISR.

    FreeRTOS-Kernel/include/task.h

    Lines 2782 to 2787 in 6cd736c

    BaseType_t xTaskGenericNotifyFromISR( TaskHandle_t xTaskToNotify,
    UBaseType_t uxIndexToNotify,
    uint32_t ulValue,
    eNotifyAction eAction,
    uint32_t * pulPreviousNotificationValue,
    BaseType_t * pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;

  • Missing * at the start of each line.

    #define QUEUE_LENGTH 10
    #define ITEM_SIZE sizeof( uint32_t )

  • The API name used in the example should be xQueueCreateStatic instead of xQueueCreate.

    * xQueue1 = xQueueCreate( QUEUE_LENGTH, // The number of items the queue can hold.
    * ITEM_SIZE // The size of each item in the queue
    * &( ucQueueStorage[ 0 ] ), // The buffer that will hold the items in the queue.
    * &xQueueBuffer ); // The buffer that will hold the queue structure.

  • The "uxBitsToWait for" in the sentence should be uxBitsToWaitFor.

    * are also set in uxCurrentEventBits. If xWaitForAllBits is pdFALSE then the
    * wait condition is met if any of the bits set in uxBitsToWait for are also set
    * in uxCurrentEventBits.

Thanks.

Browser

  • Browser: Firefox
  • Version: The version changes too often.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions