Copy edit Semaphore.h

Copy edit file for active voice.
pull/5760/head
Amanda Butler 2018-01-08 17:52:40 -06:00 committed by GitHub
parent c3b6c4d53f
commit 3621536dd5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions

View File

@ -47,7 +47,7 @@ public:
/** Create and Initialize a Semaphore object used for managing resources.
@param count number of available resources; maximum index value is (count-1). (default: 0).
@note This function cannot be called from ISR context.
@note You cannot call this function from ISR context.
*/
Semaphore(int32_t count=0);
@ -55,7 +55,7 @@ public:
@param count number of available resources
@param max_count maximum number of available resources
@note This function cannot be called from ISR context.
@note You cannot call this function from ISR context.
*/
Semaphore(int32_t count, uint16_t max_count);
@ -63,7 +63,7 @@ public:
@param millisec timeout value or 0 in case of no time-out. (default: osWaitForever).
@return number of available tokens, before taking one; or -1 in case of incorrect parameters
@note This function may be called from ISR context if the millisec parameter is set to 0.
@note You may call this function from ISR context if the millisec parameter is set to 0.
*/
int32_t wait(uint32_t millisec=osWaitForever);
@ -73,13 +73,13 @@ public:
@a osErrorResource the maximum token count has been reached.
@a osErrorParameter internal error.
@note This function may be called from ISR context.
@note You may call this function from ISR context.
*/
osStatus release(void);
/** Semaphore destructor
*
* @note This function cannot be called from ISR context.
* @note You cannot call this function from ISR context.
*/
~Semaphore();