ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Resolve Doxygen errors from RTOS. Fixed minor Doxygen bug in FileSystemHandle.h as well

pull/4508/head
Kevin Gilbert 2017-06-05 20:51:37 -05:00
parent af6f342725
commit 567589f138
3 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
rtos/MemoryPool.h
View File

@ -76,8 +76,8 @@ public:
} }
/** Free a memory block. /** Free a memory block.
@param address of the allocated memory block to be freed. @param block address of the allocated memory block to be freed.
@return status code that indicates the execution status of the function. @return status code that indicates the execution status of the function.
*/ */
osStatus free(T *block) { osStatus free(T *block) {
return osMemoryPoolFree(_id, (void*)block); return osMemoryPoolFree(_id, (void*)block);

2
rtos/Semaphore.h
View File

@ -40,7 +40,7 @@ namespace rtos {
class Semaphore { class Semaphore {
public: public:
/** Create and Initialize a Semaphore object used for managing resources. /** 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); Semaphore(int32_t count=0);

7
rtos/Thread.h
View File

@ -85,7 +85,6 @@ public:
/** Create a new thread, and start it executing the specified function. /** Create a new thread, and start it executing the specified function.
@param task function to be executed by this thread. @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 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_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). @param stack_mem pointer to the stack area to be used by this thread (default: NULL).
@ -112,9 +111,8 @@ public:
} }
/** Create a new thread, and start it executing the specified function. /** 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 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 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_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). @param stack_mem pointer to the stack area to be used by this thread (default: NULL).
@ -143,9 +141,8 @@ public:
} }
/** Create a new thread, and start it executing the specified function. /** 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 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 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_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). @param stack_mem pointer to the stack area to be used by this thread (default: NULL).