Skip to content

Doxygen RTOS updates to not produce warnings and errors [DOC Changes Only] #4464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doxyfile_options
Original file line number Diff line number Diff line change
Expand Up @@ -840,8 +840,8 @@ EXCLUDE_PATTERNS = */tools/* \
*/TESTS/* \
*/targets/* \
*/BUILD/* \
*/rtos/rtx* \
*/events/* \
*/rtos/* \
*/cmsis/* \
*/hal/* \
*/FEATURE_* \
Expand Down
2 changes: 1 addition & 1 deletion doxygen_options.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
"PREDEFINED": "DOXYGEN_ONLY \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\"",
"EXPAND_AS_DEFINED": "",
"SKIP_FUNCTION_MACROS": "NO",
"EXCLUDE_PATTERNS": "*/tools/* */TESTS/* */targets/* */FEATURE_*/* */features/mbedtls/* */features/storage/* */features/unsupported/* */features/frameworks/* */features/filesystem/* */BUILD/* */rtos/* */events/* */cmsis/* */hal/* */features/FEATURES_*"
"EXCLUDE_PATTERNS": "*/tools/* */TESTS/* */targets/* */FEATURE_*/* */features/mbedtls/* */features/storage/* */features/unsupported/* */features/frameworks/* */features/filesystem/* */BUILD/* */events/* */rtos/rtx*/* */cmsis/* */hal/* */features/FEATURES_*"
}
4 changes: 2 additions & 2 deletions rtos/MemoryPool.h
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ class MemoryPool {
}

/** Free a memory block.
@param address of the allocated memory block to be freed.
@return status code that indicates the execution status of the function.
@param block address of the allocated memory block to be freed.
@return status code that indicates the execution status of the function.
*/
osStatus free(T *block) {
return osMemoryPoolFree(_id, (void*)block);
Expand Down
2 changes: 1 addition & 1 deletion rtos/Semaphore.h
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ namespace rtos {
class Semaphore {
public:
/** Create and Initialize a Semaphore object used for managing resources.
@param number of available resources; maximum index value is (count-1). (default: 0).
@param count number of available resources; maximum index value is (count-1). (default: 0).
*/
Semaphore(int32_t count=0);

Expand Down
7 changes: 2 additions & 5 deletions rtos/Thread.h
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ class Thread {

/** Create a new thread, and start it executing the specified function.
@param task function to be executed by this thread.
@param argument pointer that is passed to the thread function as start argument. (default: NULL).
@param priority initial priority of the thread function. (default: osPriorityNormal).
@param stack_size stack size (in bytes) requirements for the thread function. (default: OS_STACK_SIZE).
@param stack_mem pointer to the stack area to be used by this thread (default: NULL).
Expand All @@ -112,9 +111,8 @@ class Thread {
}

/** Create a new thread, and start it executing the specified function.
@param obj argument to task.
@param method function to be executed by this thread.
@param argument pointer that is passed to the thread function as start argument. (default: NULL).
@param task argument to task.
@param priority initial priority of the thread function. (default: osPriorityNormal).
@param stack_size stack size (in bytes) requirements for the thread function. (default: OS_STACK_SIZE).
@param stack_mem pointer to the stack area to be used by this thread (default: NULL).
Expand Down Expand Up @@ -143,9 +141,8 @@ class Thread {
}

/** Create a new thread, and start it executing the specified function.
@param obj argument to task.
@param method function to be executed by this thread.
@param argument pointer that is passed to the thread function as start argument. (default: NULL).
@param task argument to task.
@param priority initial priority of the thread function. (default: osPriorityNormal).
@param stack_size stack size (in bytes) requirements for the thread function. (default: OS_STACK_SIZE).
@param stack_mem pointer to the stack area to be used by this thread (default: NULL).
Expand Down