Skip to content

Commit 4044733

Browse files
committed
Resolve Doxygen errors from RTOS. Fixed minor Doxygen bug in FileSystemHandle.h as well
1 parent 91016f7 commit 4044733

File tree

4 files changed

+6
-8
lines changed

4 files changed

+6
-8
lines changed

doxyfile_options

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -840,6 +840,7 @@ EXCLUDE_PATTERNS = */tools/* \
840840
*/TESTS/* \
841841
*/targets/* \
842842
*/BUILD/* \
843+
*/rtos/rtx* \
843844
*/events/* \
844845
*/cmsis/* \
845846
*/hal/* \

rtos/MemoryPool.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ class MemoryPool {
7676
}
7777

7878
/** Free a memory block.
79-
@param address of the allocated memory block to be freed.
80-
@return status code that indicates the execution status of the function.
79+
@param block address of the allocated memory block to be freed.
80+
@return status code that indicates the execution status of the function.
8181
*/
8282
osStatus free(T *block) {
8383
return osMemoryPoolFree(_id, (void*)block);

rtos/Semaphore.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ namespace rtos {
4040
class Semaphore {
4141
public:
4242
/** Create and Initialize a Semaphore object used for managing resources.
43-
@param number of available resources; maximum index value is (count-1). (default: 0).
43+
@param count number of available resources; maximum index value is (count-1). (default: 0).
4444
*/
4545
Semaphore(int32_t count=0);
4646

rtos/Thread.h

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,6 @@ class Thread {
8585

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

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

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

0 commit comments

Comments
 (0)