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

Copy edit CallChainOfFunctionPointersWithContext.h 

Make minor copy edits, mostly for typos.
pull/5392/head
Amanda Butler 2017-11-07 15:30:27 -06:00 committed by GitHub
parent 3cbe3918e7
commit 0f91ea2b2a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
features/FEATURE_BLE/ble/CallChainOfFunctionPointersWithContext.h
View File

@ -30,7 +30,7 @@
/** /**
* Function like object hosting a list of FunctionPointerWithContext. * Function like object hosting a list of FunctionPointerWithContext.
* *
* Upon call each FunctionPointerWithContext instance present in the object will * Upon call, each FunctionPointerWithContext instance present in the object will
* be called in sequence with the initial parameters. * be called in sequence with the initial parameters.
* *
* It can be seen as a variation of the observer pattern this object being the * It can be seen as a variation of the observer pattern this object being the
@ -83,7 +83,7 @@ class CallChainOfFunctionPointersWithContext :
public SafeBool<CallChainOfFunctionPointersWithContext<ContextType> > { public SafeBool<CallChainOfFunctionPointersWithContext<ContextType> > {
public: public:
/** /**
* Alias of the FunctionPointerWithContext type this object can store * Alias of the FunctionPointerWithContext type this object can store.
*/ */
typedef FunctionPointerWithContext<ContextType> *pFunctionPointerWithContext_t; typedef FunctionPointerWithContext<ContextType> *pFunctionPointerWithContext_t;
@ -148,8 +148,8 @@ public:
* *
* @return true if a function pointer has been detached and false otherwise. * @return true if a function pointer has been detached and false otherwise.
* *
* @note It is safe to remove a function pointer while the chain is * @note It is safe to remove a function pointer while
* being traversed by call(ContextType). * call(ContextType) is traversing the chain.
*/ */
bool detach(const FunctionPointerWithContext<ContextType> &toDetach) bool detach(const FunctionPointerWithContext<ContextType> &toDetach)
{ {
@ -261,7 +261,7 @@ public:
} }
/** /**
* Test if the calchain is emtpy or not. * Test if the callchain is empty or not.
* *
* @return true if the callchain is not empty and false otherwise. * @return true if the callchain is not empty and false otherwise.
* *
@ -317,7 +317,7 @@ private:
* removed during the call() operation. * removed during the call() operation.
* *
* @note It has to be mutable to accomodate the const version of call(). The * @note It has to be mutable to accomodate the const version of call(). The
* iterator doesn't leak outside the object therefore it remains seen as * iterator doesn't leak outside the object; therefore, it remains seen as
* const from an external standpoint. * const from an external standpoint.
*/ */
mutable pFunctionPointerWithContext_t currentCalled; mutable pFunctionPointerWithContext_t currentCalled;