doc: small review + added links to docsforge (close #210)
This commit is contained in:
parent
f9056e732c
commit
dc67c97ab2
1
AUTHORS
1
AUTHORS
@ -26,3 +26,4 @@ richardbmx
|
|||||||
wnsgml972
|
wnsgml972
|
||||||
ffontaine
|
ffontaine
|
||||||
elindsey
|
elindsey
|
||||||
|
erez-o
|
||||||
|
|||||||
15
README.md
15
README.md
@ -5,6 +5,7 @@
|
|||||||
-->
|
-->
|
||||||
[](https://github.com/skypjack/uvw/actions)
|
[](https://github.com/skypjack/uvw/actions)
|
||||||
[](https://codecov.io/gh/skypjack/uvw)
|
[](https://codecov.io/gh/skypjack/uvw)
|
||||||
|
[](http://uvw.docsforge.com/)
|
||||||
[](https://bintray.com/skypjack/conan/uvw%3Askypjack/_latestVersion)
|
[](https://bintray.com/skypjack/conan/uvw%3Askypjack/_latestVersion)
|
||||||
[](https://gitter.im/skypjack/uvw)
|
[](https://gitter.im/skypjack/uvw)
|
||||||
[](https://www.paypal.me/skypjack)
|
[](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
|
To use `uvw` as a compiled library, set the `BUILD_UVW_LIBS` options in cmake
|
||||||
before including the project.<br/>
|
before including the project.<br/>
|
||||||
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
|
`uvw::uvw-static`. The matching version of `libuv` is also
|
||||||
compiled and exported as `uv::uv-static` for convenience.
|
compiled and exported as `uv::uv-static` for convenience.
|
||||||
|
|
||||||
@ -183,8 +184,11 @@ To navigate it with your favorite browser:
|
|||||||
* `$ cd build`
|
* `$ cd build`
|
||||||
* `$ your_favorite_browser docs/html/index.html`
|
* `$ your_favorite_browser docs/html/index.html`
|
||||||
|
|
||||||
The API reference is also available [online](https://skypjack.github.io/uvw/)
|
The same version is also available [online](https://skypjack.github.io/uvw/)
|
||||||
for the latest version.
|
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
|
### Note
|
||||||
|
|
||||||
@ -349,9 +353,8 @@ It means that the following function types are all valid:
|
|||||||
* `void(EventType &, const ResourceType &)`
|
* `void(EventType &, const ResourceType &)`
|
||||||
* `void(const EventType &, const ResourceType &)`
|
* `void(const EventType &, const ResourceType &)`
|
||||||
|
|
||||||
Once more, please note that there is no need to keep around references to the
|
Please note that there is no need to keep around references to the resources:
|
||||||
resources: they will pass themselves as an argument whenever an event is
|
they will pass themselves as an argument whenever an event is published.
|
||||||
published.
|
|
||||||
|
|
||||||
There exist two methods to attach a listener to a resource:
|
There exist two methods to attach a listener to a resource:
|
||||||
|
|
||||||
|
|||||||
@ -253,7 +253,7 @@ extern template std::pair<bool, std::pair<const char *, const char *>> GetNameIn
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Internal details not to be documented.
|
* Internal details not to be documented.
|
||||||
* @endcond TURN_OFF_DOXYGEN
|
* @endcond
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -12,6 +12,11 @@
|
|||||||
namespace uvw {
|
namespace uvw {
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Request base class.
|
||||||
|
*
|
||||||
|
* Base type for all `uvw` request types.
|
||||||
|
*/
|
||||||
template<typename T, typename U>
|
template<typename T, typename U>
|
||||||
class Request: public Resource<T, U> {
|
class Request: public Resource<T, U> {
|
||||||
protected:
|
protected:
|
||||||
|
|||||||
@ -259,7 +259,7 @@ extern template void TCPHandle::connect<IPv6>(Addr addr);
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Internal details not to be documented.
|
* Internal details not to be documented.
|
||||||
* @endcond TURN_OFF_DOXYGEN
|
* @endcond
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -644,7 +644,7 @@ extern template void UDPHandle::recv<IPv6>();
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Internal details not to be documented.
|
* Internal details not to be documented.
|
||||||
* @endcond TURN_OFF_DOXYGEN
|
* @endcond
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user