Skip to content

Fix comment and example typos in list.h, queue.h and task.h - #1460

Closed
zepp-chen wants to merge 1 commit into
FreeRTOS:mainfrom
zepp-chen:fix/comment-typos
Closed

Fix comment and example typos in list.h, queue.h and task.h#1460
zepp-chen wants to merge 1 commit into
FreeRTOS:mainfrom
zepp-chen:fix/comment-typos

Conversation

@zepp-chen

@zepp-chen zepp-chen commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Fix several documentation and example-code issues in the kernel header comments:

  • queue.h: remove a stray semicolon after the 'if' and correct the xHigherPriorityTaskWoken variable casing in the xQueueReceiveFromISR() example; add the missing comma between parameters in the xQueueGenericSend() prototype example.
  • list.h: correct the doxygen \page tag for listGET_ITEM_VALUE_OF_HEAD_ENTRY.
  • task.h: fix the uxIndexToCLear typo (-> uxIndexToClear).

These are documentation/example only changes that do not affect the compiled library.

Description

Test Steps

Checklist:

  • I have tested my changes. No regression in existing tests.
  • I have modified and/or added unit-tests to cover the code changes in this Pull Request.

Related Issue

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Fix several documentation and example-code issues in the kernel header comments:

 * queue.h: remove a stray semicolon after the 'if' and correct the
   xHigherPriorityTaskWoken variable casing in the xQueueReceiveFromISR()
   example; add the missing comma between parameters in the
   xQueueGenericSend() prototype example.
 * list.h: correct the doxygen \page tag for listGET_ITEM_VALUE_OF_HEAD_ENTRY.
 * task.h: fix the uxIndexToCLear typo (-> uxIndexToClear).

These are documentation/example only changes that do not affect the
compiled library.

Signed-off-by: chenrongjun <chenrongjun@zepp.com>
@sonarqubecloud

Copy link
Copy Markdown

@AniruddhaKanhere AniruddhaKanhere left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution @zepp-chen.

Looks good to me.

@AniruddhaKanhere

Copy link
Copy Markdown
Member

Thank you for the PR @zepp-chen. I am closing this however in favor of #1461 since that PR is the superset of this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants