diff options
| author | William A. Kennington III <wak@google.com> | 2018-09-19 23:05:11 -0700 |
|---|---|---|
| committer | William A. Kennington III <wak@google.com> | 2018-09-19 23:23:31 -0700 |
| commit | 7f58b2a1ec99272e0c192a1981df4ea13284bc1f (patch) | |
| tree | d313d4c529d20131441854532db28f17f736b002 /src | |
| parent | 65da782a58c0f12a4f717c9700a3fb1bdb02ad8a (diff) | |
| download | sdeventplus-7f58b2a1ec99272e0c192a1981df4ea13284bc1f.tar.gz sdeventplus-7f58b2a1ec99272e0c192a1981df4ea13284bc1f.zip | |
source/io: Fix documentation
The original constructor documentation was copied and pasted incorrectly
from somewhere else.
Change-Id: Iac8dbd197e710d4079400c99c368f07c32f90a9d
Signed-off-by: William A. Kennington III <wak@google.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/sdeventplus/source/io.hpp | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/src/sdeventplus/source/io.hpp b/src/sdeventplus/source/io.hpp index f26eac8..724c633 100644 --- a/src/sdeventplus/source/io.hpp +++ b/src/sdeventplus/source/io.hpp @@ -18,9 +18,10 @@ class IO : public Base /** @brief Adds a new IO source handler to the Event * Executes the callback upon events occurring * - * @param[in] name - The name identifying the create function - * @param[in] create - The SdEvent function called to create the source - * @param[in] event - The event to attach the handler + * @param[in] event - The event to attach the handler + * @param[in] fd - The file descriptor producing the events + * @param[in] events - The event mask passed which determines triggers + * See epoll_ctl(2) for more info on the mask * @param[in] callback - The function executed on event dispatch * @throws SdEventError for underlying sd_event errors */ |
