diff --git a/AUTHORS b/AUTHORS index 3f4bb058..e96a2f30 100644 --- a/AUTHORS +++ b/AUTHORS @@ -26,3 +26,4 @@ richardbmx wnsgml972 ffontaine elindsey +erez-o diff --git a/README.md b/README.md index b2b505eb..4b4ccacd 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ --> [![Build Status](https://github.com/skypjack/uvw/workflows/build/badge.svg)](https://github.com/skypjack/uvw/actions) [![Coverage](https://codecov.io/gh/skypjack/uvw/branch/master/graph/badge.svg)](https://codecov.io/gh/skypjack/uvw) +[![Documentation](https://img.shields.io/badge/docs-docsforge-blue)](http://uvw.docsforge.com/) [![Download](https://api.bintray.com/packages/skypjack/conan/uvw%3Askypjack/images/download.svg)](https://bintray.com/skypjack/conan/uvw%3Askypjack/_latestVersion) [![Gitter chat](https://badges.gitter.im/skypjack/uvw.png)](https://gitter.im/skypjack/uvw) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/skypjack) @@ -134,7 +135,7 @@ When used through `CMake`, the `uvw::uvw` target is exported for convenience. To use `uvw` as a compiled library, set the `BUILD_UVW_LIBS` options in cmake before including the project.
-This option triggers the generation of a targets named +This option triggers the generation of a targets named `uvw::uvw-static`. The matching version of `libuv` is also compiled and exported as `uv::uv-static` for convenience. @@ -183,8 +184,11 @@ To navigate it with your favorite browser: * `$ cd build` * `$ your_favorite_browser docs/html/index.html` -The API reference is also available [online](https://skypjack.github.io/uvw/) -for the latest version. +The same version is also available [online](https://skypjack.github.io/uvw/) +for the latest release, that is the last stable tag. If you are looking for +something more pleasing to the eye, consider reading the nice-looking version +available on [docsforge](https://uvw.docsforge.com/): same documentation, much +more pleasant to read. ### Note @@ -349,9 +353,8 @@ It means that the following function types are all valid: * `void(EventType &, const ResourceType &)` * `void(const EventType &, const ResourceType &)` -Once more, please note that there is no need to keep around references to the -resources: they will pass themselves as an argument whenever an event is -published. +Please note that there is no need to keep around references to the resources: +they will pass themselves as an argument whenever an event is published. There exist two methods to attach a listener to a resource: diff --git a/src/uvw/dns.h b/src/uvw/dns.h index 6ba99d26..5c91c521 100644 --- a/src/uvw/dns.h +++ b/src/uvw/dns.h @@ -253,7 +253,7 @@ extern template std::pair> GetNameIn /** * Internal details not to be documented. - * @endcond TURN_OFF_DOXYGEN + * @endcond */ diff --git a/src/uvw/request.hpp b/src/uvw/request.hpp index 212ad395..0a9d9ed1 100644 --- a/src/uvw/request.hpp +++ b/src/uvw/request.hpp @@ -12,6 +12,11 @@ namespace uvw { +/** + * @brief Request base class. + * + * Base type for all `uvw` request types. + */ template class Request: public Resource { protected: diff --git a/src/uvw/tcp.h b/src/uvw/tcp.h index aa4600b8..9631426f 100644 --- a/src/uvw/tcp.h +++ b/src/uvw/tcp.h @@ -259,7 +259,7 @@ extern template void TCPHandle::connect(Addr addr); /** * Internal details not to be documented. - * @endcond TURN_OFF_DOXYGEN + * @endcond */ diff --git a/src/uvw/udp.h b/src/uvw/udp.h index a64c2911..9bd221ef 100644 --- a/src/uvw/udp.h +++ b/src/uvw/udp.h @@ -644,7 +644,7 @@ extern template void UDPHandle::recv(); /** * Internal details not to be documented. - * @endcond TURN_OFF_DOXYGEN + * @endcond */