Skip to content

Commit

Permalink
Fixed typos
Browse files Browse the repository at this point in the history
  • Loading branch information
wqking committed Jul 9, 2018
1 parent 46285cb commit 9290427
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions doc/conditionalremover.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Description

ConditionalRemover is a utility class that automatically removes listeners after the listeners are triggered and certain condition is met.
ConditionalRemover is a utility class that automatically removes listeners after the listeners are triggered and certain condition is satisfied.
ConditionalRemover is a pure functional class. After the member functions in ConditionalRemover are invoked, the ConditionalRemover object can be destroyed safely.

<a name="apis"></a>
Expand Down Expand Up @@ -87,7 +87,7 @@ ConditionalRemover<DispatcherType> conditionalRemover(DispatcherType & dispatche

Since ConditionalRemover takes one template parameter and it's verbose to instantiate its instance, the function `conditionalRemover` is used to construct an instance of ConditionalRemover via the deduced argument.

### Same code
### Sample code

```c++
#include "eventpp/utilities/conditionalRemover.h"
Expand Down
2 changes: 1 addition & 1 deletion doc/counterremover.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ CounterRemover<DispatcherType> counterRemover(DispatcherType & dispatcher);

Since CounterRemover takes one template parameter and it's verbose to instantiate its instance, the function `counterRemover` is used to construct an instance of CounterRemover via the deduced argument.

### Same code
### Sample code

```c++
#include "eventpp/utilities/counterremover.h"
Expand Down
4 changes: 2 additions & 2 deletions doc/scopedremover.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,12 @@ typename CallbackListType::Handle insert(
);
```
The function `reset()` removes all listeners from the dispatcher or callback list, as if the ScopedRemover object has gone out of scope.
The function `reset()` removes all listeners which added by ScopedRemover from the dispatcher or callback list, as if the ScopedRemover object has gone out of scope.
The function `setDispatcher()` and `setCallbackList` sets the dispatcher or callback list, and reset the ScopedRemover object.
The other member functions that have the same names with the corresponding underlying class (CallbackList, EventDispatcher, or EventQueue). Those functions add listener to the dispatcher.
### Same code
### Sample code
```c++
#include "eventpp/utilities/scopedremover.h"
Expand Down
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ queue.process();
* [Class EventDispatcher](doc/eventdispatcher.md)
* [Class EventQueue](doc/eventqueue.md)
* [Utility class CounterRemover -- auto remove listeners after triggered certain times](doc/counterremover.md)
* [Utility class ConditionalRemover -- auto remove listeners when certain condition is met](doc/conditionalremover.md)
* [Utility class ConditionalRemover -- auto remove listeners when certain condition is satisfied](doc/conditionalremover.md)
* [Utility class ScopedRemover -- auto remove listeners when out of scope](doc/scopedremover.md)
* [Document of utilities](doc/eventutil.md)
* [Policies -- configure eventpp](doc/policies.md)
Expand Down

0 comments on commit 9290427

Please sign in to comment.