From c8d4177992e47421ad4ea8ab3ce2b080fc890bc0 Mon Sep 17 00:00:00 2001 From: Michele Caini Date: Mon, 22 Aug 2016 12:33:51 +0200 Subject: [PATCH] docs --- src/uvw/fs.hpp | 94 ++++++++++++++++++++++---------------------- src/uvw/fs_event.hpp | 16 ++++---- src/uvw/loop.hpp | 12 +++--- src/uvw/poll.hpp | 20 +++++----- src/uvw/process.hpp | 34 ++++++++-------- src/uvw/tcp.hpp | 8 ++-- src/uvw/tty.hpp | 12 +++--- src/uvw/udp.hpp | 12 +++--- 8 files changed, 104 insertions(+), 104 deletions(-) diff --git a/src/uvw/fs.hpp b/src/uvw/fs.hpp index b7e0c52d..dd44371a 100644 --- a/src/uvw/fs.hpp +++ b/src/uvw/fs.hpp @@ -71,36 +71,36 @@ enum class UVDirentTypeT: std::underlying_type_t { * * Available types are: * - * * FsRequest::Type::UNKNOWN - * * FsRequest::Type::CUSTOM - * * FsRequest::Type::OPEN - * * FsRequest::Type::CLOSE - * * FsRequest::Type::READ - * * FsRequest::Type::WRITE - * * FsRequest::Type::SENDFILE - * * FsRequest::Type::STAT - * * FsRequest::Type::LSTAT - * * FsRequest::Type::FSTAT - * * FsRequest::Type::FTRUNCATE - * * FsRequest::Type::UTIME - * * FsRequest::Type::FUTIME - * * FsRequest::Type::ACCESS - * * FsRequest::Type::CHMOD - * * FsRequest::Type::FCHMOD - * * FsRequest::Type::FSYNC - * * FsRequest::Type::FDATASYNC - * * FsRequest::Type::UNLINK - * * FsRequest::Type::RMDIR - * * FsRequest::Type::MKDIR - * * FsRequest::Type::MKDTEMP - * * FsRequest::Type::RENAME - * * FsRequest::Type::SCANDIR - * * FsRequest::Type::LINK - * * FsRequest::Type::SYMLINK - * * FsRequest::Type::READLINK - * * FsRequest::Type::CHOWN - * * FsRequest::Type::FCHOWN - * * FsRequest::Type::REALPATH + * * `FsRequest::Type::UNKNOWN` + * * `FsRequest::Type::CUSTOM` + * * `FsRequest::Type::OPEN` + * * `FsRequest::Type::CLOSE` + * * `FsRequest::Type::READ` + * * `FsRequest::Type::WRITE` + * * `FsRequest::Type::SENDFILE` + * * `FsRequest::Type::STAT` + * * `FsRequest::Type::LSTAT` + * * `FsRequest::Type::FSTAT` + * * `FsRequest::Type::FTRUNCATE` + * * `FsRequest::Type::UTIME` + * * `FsRequest::Type::FUTIME` + * * `FsRequest::Type::ACCESS` + * * `FsRequest::Type::CHMOD` + * * `FsRequest::Type::FCHMOD` + * * `FsRequest::Type::FSYNC` + * * `FsRequest::Type::FDATASYNC` + * * `FsRequest::Type::UNLINK` + * * `FsRequest::Type::RMDIR` + * * `FsRequest::Type::MKDIR` + * * `FsRequest::Type::MKDTEMP` + * * `FsRequest::Type::RENAME` + * * `FsRequest::Type::SCANDIR` + * * `FsRequest::Type::LINK` + * * `FsRequest::Type::SYMLINK` + * * `FsRequest::Type::READLINK` + * * `FsRequest::Type::CHOWN` + * * `FsRequest::Type::FCHOWN` + * * `FsRequest::Type::REALPATH` * * It will be emitted by FsReq and/or FileReq according with their * functionalities. @@ -125,7 +125,7 @@ private: /** - * @brief FsEvent event specialization for FsRequest::Type::READ. + * @brief FsEvent event specialization for `FsRequest::Type::READ`. * * It will be emitted by FsReq and/or FileReq according with their * functionalities. @@ -164,7 +164,7 @@ private: /** - * @brief FsEvent event specialization for FsRequest::Type::WRITE. + * @brief FsEvent event specialization for `FsRequest::Type::WRITE`. * * It will be emitted by FsReq and/or FileReq according with their * functionalities. @@ -196,7 +196,7 @@ private: /** - * @brief FsEvent event specialization for FsRequest::Type::SENDFILE. + * @brief FsEvent event specialization for `FsRequest::Type::SENDFILE`. * * It will be emitted by FsReq and/or FileReq according with their * functionalities. @@ -228,7 +228,7 @@ private: /** - * @brief FsEvent event specialization for FsRequest::Type::STAT. + * @brief FsEvent event specialization for `FsRequest::Type::STAT`. * * It will be emitted by FsReq and/or FileReq according with their * functionalities. @@ -260,7 +260,7 @@ private: /** - * @brief FsEvent event specialization for FsRequest::Type::FSTAT. + * @brief FsEvent event specialization for `FsRequest::Type::FSTAT`. * * It will be emitted by FsReq and/or FileReq according with their * functionalities. @@ -292,7 +292,7 @@ private: /** - * @brief FsEvent event specialization for FsRequest::Type::LSTAT. + * @brief FsEvent event specialization for `FsRequest::Type::LSTAT`. * * It will be emitted by FsReq and/or FileReq according with their * functionalities. @@ -324,7 +324,7 @@ private: /** - * @brief FsEvent event specialization for FsRequest::Type::SCANDIR. + * @brief FsEvent event specialization for `FsRequest::Type::SCANDIR`. * * It will be emitted by FsReq and/or FileReq according with their * functionalities. @@ -356,7 +356,7 @@ private: /** - * @brief FsEvent event specialization for FsRequest::Type::READLINK. + * @brief FsEvent event specialization for `FsRequest::Type::READLINK`. * * It will be emitted by FsReq and/or FileReq according with their * functionalities. @@ -979,14 +979,14 @@ public: * * Available entry types are: * - * * FsReq::EntryType::UNKNOWN - * * FsReq::EntryType::FILE - * * FsReq::EntryType::DIR - * * FsReq::EntryType::LINK - * * FsReq::EntryType::FIFO - * * FsReq::EntryType::SOCKET - * * FsReq::EntryType::CHAR - * * FsReq::EntryType::BLOCK + * * `FsReq::EntryType::UNKNOWN` + * * `FsReq::EntryType::FILE` + * * `FsReq::EntryType::DIR` + * * `FsReq::EntryType::LINK` + * * `FsReq::EntryType::FIFO` + * * `FsReq::EntryType::SOCKET` + * * `FsReq::EntryType::CHAR` + * * `FsReq::EntryType::BLOCK` * * See the official * [documentation](http://docs.libuv.org/en/v1.x/fs.html#c.uv_dirent_t) @@ -996,7 +996,7 @@ public: * * * The first parameter is a boolean value that indicates if the current * entry is still valid. - * * The second parameter is an instance of Entry (see above). + * * The second parameter is an instance of `Entry` (see above). */ std::pair scandirNext() { uv_dirent_t dirent; diff --git a/src/uvw/fs_event.hpp b/src/uvw/fs_event.hpp index 2e0c6d64..53febbe0 100644 --- a/src/uvw/fs_event.hpp +++ b/src/uvw/fs_event.hpp @@ -57,8 +57,8 @@ struct FsEventEvent: Event { * * Available flags are: * - * * FsEventHandle::Watch::RENAME - * * FsEventHandle::Watch::CHANGE + * * `FsEventHandle::Watch::RENAME` + * * `FsEventHandle::Watch::CHANGE` * * @return Detected events all in one. */ @@ -122,9 +122,9 @@ public: * * Available flags are: * - * * FsEventHandle::Event::WATCH_ENTRY - * * FsEventHandle::Event::STAT - * * FsEventHandle::Event::RECURSIVE + * * `FsEventHandle::Event::WATCH_ENTRY` + * * `FsEventHandle::Event::STAT` + * * `FsEventHandle::Event::RECURSIVE` * * @param path The file or directory to be monitored. * @param flags Additional flags to control the behavior. @@ -143,9 +143,9 @@ public: * * Available flags are: * - * * FsEventHandle::Event::WATCH_ENTRY - * * FsEventHandle::Event::STAT - * * FsEventHandle::Event::RECURSIVE + * * `FsEventHandle::Event::WATCH_ENTRY` + * * `FsEventHandle::Event::STAT` + * * `FsEventHandle::Event::RECURSIVE` * * @param path The file or directory to be monitored. * @param watch Additional flag to control the behavior. diff --git a/src/uvw/loop.hpp b/src/uvw/loop.hpp index 27b6aa45..6d1a1dda 100644 --- a/src/uvw/loop.hpp +++ b/src/uvw/loop.hpp @@ -193,7 +193,7 @@ public: * mentioned otherwise.
* Supported options: * - * * Loop::Configure::BLOCK_SIGNAL: Block a signal when polling for new + * * `Loop::Configure::BLOCK_SIGNAL`: Block a signal when polling for new * events. A second argument is required and it is the signal number. * * An ErrorEvent will be emitted in case of errors. @@ -260,11 +260,11 @@ public: * * Available modes are: * - * * Loop::Mode::DEFAULT: Runs the event loop until there are no more active - * and referenced handles or requests. - * * Loop::Mode::ONCE: Poll for i/o once. Note that this function blocks if - * there are no pending callbacks. - * * Loop::Mode::NOWAIT: Poll for i/o once but don’t block if there are no + * * `Loop::Mode::DEFAULT`: Runs the event loop until there are no more + * active and referenced handles or requests. + * * `Loop::Mode::ONCE`: Poll for i/o once. Note that this function blocks + * if there are no pending callbacks. + * * `Loop::Mode::NOWAIT`: Poll for i/o once but don’t block if there are no * pending callbacks. * * See the official diff --git a/src/uvw/poll.hpp b/src/uvw/poll.hpp index 805d5c22..316e9667 100644 --- a/src/uvw/poll.hpp +++ b/src/uvw/poll.hpp @@ -42,9 +42,9 @@ struct PollEvent: Event { * * Available flags are: * - * * PollHandle::Event::READABLE - * * PollHandle::Event::WRITABLE - * * PollHandle::Event::DISCONNECT + * * `PollHandle::Event::READABLE` + * * `PollHandle::Event::WRITABLE` + * * `PollHandle::Event::DISCONNECT` * * @return Detected events all in one. */ @@ -90,7 +90,7 @@ public: * * A pointer to the loop from which the handle generated. * * A descriptor that can be: * * either an `int` file descriptor - * * or a OSSocketHandle socket descriptor + * * or a `OSSocketHandle` socket descriptor * * See the official * [documentation](http://docs.libuv.org/en/v1.x/poll.html) @@ -118,9 +118,9 @@ public: * * Available flags are: * - * * PollHandle::Event::READABLE - * * PollHandle::Event::WRITABLE - * * PollHandle::Event::DISCONNECT + * * `PollHandle::Event::READABLE` + * * `PollHandle::Event::WRITABLE` + * * `PollHandle::Event::DISCONNECT` * * As soon as an event is detected, a PollEvent is emitted by the * handle.
@@ -140,9 +140,9 @@ public: * * Available flags are: * - * * PollHandle::Event::READABLE - * * PollHandle::Event::WRITABLE - * * PollHandle::Event::DISCONNECT + * * `PollHandle::Event::READABLE` + * * `PollHandle::Event::WRITABLE` + * * `PollHandle::Event::DISCONNECT` * * As soon as an event is detected, a PollEvent is emitted by the * handle.
diff --git a/src/uvw/process.hpp b/src/uvw/process.hpp index 4575c920..641e7b9c 100644 --- a/src/uvw/process.hpp +++ b/src/uvw/process.hpp @@ -176,11 +176,11 @@ public: * * Available flags are: * - * * ProcessHandle::Process::SETUID - * * ProcessHandle::Process::SETGID - * * ProcessHandle::Process::WINDOWS_VERBATIM_ARGUMENTS - * * ProcessHandle::Process::DETACHED - * * ProcessHandle::Process::WINDOWS_HIDE + * * `ProcessHandle::Process::SETUID` + * * `ProcessHandle::Process::SETGID` + * * `ProcessHandle::Process::WINDOWS_VERBATIM_ARGUMENTS` + * * `ProcessHandle::Process::DETACHED` + * * `ProcessHandle::Process::WINDOWS_HIDE` * * See the official * [documentation](http://docs.libuv.org/en/v1.x/process.html#c.uv_process_flags) @@ -199,12 +199,12 @@ public: * * Available flags are: * - * * ProcessHandle::StdIO::IGNORE - * * ProcessHandle::StdIO::CREATE_PIPE - * * ProcessHandle::StdIO::INHERIT_FD - * * ProcessHandle::StdIO::INHERIT_STREAM - * * ProcessHandle::StdIO::READABLE_PIPE - * * ProcessHandle::StdIO::WRITABLE_PIPE + * * `ProcessHandle::StdIO::IGNORE` + * * `ProcessHandle::StdIO::CREATE_PIPE` + * * `ProcessHandle::StdIO::INHERIT_FD` + * * `ProcessHandle::StdIO::INHERIT_STREAM` + * * `ProcessHandle::StdIO::READABLE_PIPE` + * * `ProcessHandle::StdIO::WRITABLE_PIPE` * * See the official * [documentation](http://docs.libuv.org/en/v1.x/process.html#c.uv_stdio_flags) @@ -229,12 +229,12 @@ public: * * Available flags are: * - * * ProcessHandle::StdIO::IGNORE - * * ProcessHandle::StdIO::CREATE_PIPE - * * ProcessHandle::StdIO::INHERIT_FD - * * ProcessHandle::StdIO::INHERIT_STREAM - * * ProcessHandle::StdIO::READABLE_PIPE - * * ProcessHandle::StdIO::WRITABLE_PIPE + * * `ProcessHandle::StdIO::IGNORE` + * * `ProcessHandle::StdIO::CREATE_PIPE` + * * `ProcessHandle::StdIO::INHERIT_FD` + * * `ProcessHandle::StdIO::INHERIT_STREAM` + * * `ProcessHandle::StdIO::READABLE_PIPE` + * * `ProcessHandle::StdIO::WRITABLE_PIPE` * * See the official * [documentation](http://docs.libuv.org/en/v1.x/process.html#c.uv_stdio_flags) diff --git a/src/uvw/tcp.hpp b/src/uvw/tcp.hpp index dca3da3e..179254ae 100644 --- a/src/uvw/tcp.hpp +++ b/src/uvw/tcp.hpp @@ -133,8 +133,8 @@ public: * * Available flags are: * - * * TcpHandle::Bind::IPV6ONLY: it disables dual-stack support and only IPv6 - * is used. + * * `TcpHandle::Bind::IPV6ONLY`: it disables dual-stack support and only + * IPv6 is used. * * @param ip The address to which to bind. * @param port The port to which to bind. @@ -157,8 +157,8 @@ public: * * Available flags are: * - * * TcpHandle::Bind::IPV6ONLY: it disables dual-stack support and only IPv6 - * is used. + * * `TcpHandle::Bind::IPV6ONLY`: it disables dual-stack support and only + * IPv6 is used. * * @param addr A valid instance of Addr. * @param flags Optional additional flags. diff --git a/src/uvw/tty.hpp b/src/uvw/tty.hpp index 6e7f7d3f..f8d9a8e4 100644 --- a/src/uvw/tty.hpp +++ b/src/uvw/tty.hpp @@ -58,9 +58,9 @@ public: * * * A pointer to the loop from which the handle generated. * * A valid FileHandle. Usually the file descriptor will be: - * * 0 = stdin - * * 1 = stdout - * * 2 = stderr + * * `0` = `stdin` + * * `1` = `stdout` + * * `2` = `stderr` * * A boolean value (_readable_) that specifies the plan on calling `read()` with this * stream. Remember that `stdin` is readable, `stdout` is not. * @@ -91,9 +91,9 @@ public: * * Available modes are: * - * * TTY::Mode::NORMAL - * * TTY::Mode::RAW - * * TTY::Mode::IO + * * `TTY::Mode::NORMAL` + * * `TTY::Mode::RAW` + * * `TTY::Mode::IO` * * See the official * [documentation](http://docs.libuv.org/en/v1.x/tty.html#c.uv_tty_mode_t) diff --git a/src/uvw/udp.hpp b/src/uvw/udp.hpp index 3b5fbee5..f4a581b3 100644 --- a/src/uvw/udp.hpp +++ b/src/uvw/udp.hpp @@ -192,8 +192,8 @@ public: * * Available flags are: * - * * UDPHandle::Bind::IPV6ONLY - * * UDPHandle::Bind::REUSEADDR + * * `UDPHandle::Bind::IPV6ONLY` + * * `UDPHandle::Bind::REUSEADDR` * * See the official * [documentation](http://docs.libuv.org/en/v1.x/udp.html#c.uv_udp_flags) @@ -215,8 +215,8 @@ public: * * Available flags are: * - * * UDPHandle::Bind::IPV6ONLY - * * UDPHandle::Bind::REUSEADDR + * * `UDPHandle::Bind::IPV6ONLY` + * * `UDPHandle::Bind::REUSEADDR` * * See the official * [documentation](http://docs.libuv.org/en/v1.x/udp.html#c.uv_udp_flags) @@ -244,8 +244,8 @@ public: * * Available values for `membership` are: * - * * UDPHandle::Membership::LEAVE_GROUP - * * UDPHandle::Membership::JOIN_GROUP + * * `UDPHandle::Membership::LEAVE_GROUP` + * * `UDPHandle::Membership::JOIN_GROUP` * * @param multicast Multicast address to set membership for. * @param interface Interface address.