diff --git a/src/uvw/resource.hpp b/src/uvw/resource.hpp index d6b7d786..8a7e24bb 100644 --- a/src/uvw/resource.hpp +++ b/src/uvw/resource.hpp @@ -12,6 +12,12 @@ namespace uvw { +/** + * @brief Common class for almost all the resources available in `uvw`. + * + * This is the base class for handles and requests.
+ * It mainly acts as a wrapper around a libuv's data structure. + */ template class Resource: public Emitter, public Self { template @@ -52,6 +58,10 @@ public: Resource& operator=(const Resource &) = delete; Resource& operator=(Resource &&) = delete; + /** + * @brief Gets the loop from which the resource was originated. + * @return A reference to a loop instance. + */ Loop& loop() const noexcept { return *pLoop; } private: