better doc

CMakeLists.txt

@@ -155,7 +155,8 @@ include(CPack)
 
 file(
     GLOB_RECURSE PROJECT_FILES FOLLOW_SYMLINKS
-    *.txt *.c *.cpp *.hpp *.h *.in *.cmake *.sh *.md *.yml *.bat AUTHORS LICENSE
+    *.txt *.c *.cpp *.hpp *.h *.in *.dox *.cmake *.sh *.md *.yml *.bat
+    AUTHORS LICENSE
 )
 
 add_custom_target(

docs/CMakeLists.txt

@@ -6,6 +6,7 @@ set(TARGET_DOCS docs)
 
 set(DOXY_IN_FILE doxy.in)
 
+set(DOXY_DOCS_DIRECTORY ${PROJECT_DOCS_DIR})
 set(DOXY_SOURCE_DIRECTORY ${PROJECT_SRC_DIR})
 set(DOXY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
 set(DOXY_CFG_FILE doxy.cfg)

docs/doxy.in

@@ -758,7 +758,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @DOXY_SOURCE_DIRECTORY@ @PROJECT_SOURCE_DIR@/README.md
+INPUT                  = @DOXY_SOURCE_DIRECTORY@ @DOXY_DOCS_DIRECTORY@ @PROJECT_SOURCE_DIR@/README.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -778,7 +778,7 @@ INPUT_ENCODING         = UTF-8
 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
 # *.qsf, *.as and *.js.
 
-FILE_PATTERNS          =
+FILE_PATTERNS          = *.hpp *.dox *.md
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.

docs/extra.dox

@@ -0,0 +1,5 @@
+/**
+ * @namespace uvw
+ *
+ * @brief `uvw` default namespace.
+ */

src/uvw/util.hpp

@@ -180,23 +180,23 @@ struct WinSize {
 };
 
 
-using HandleType = details::UVHandleType;
+using HandleType = details::UVHandleType; /*!< The type of a handle. */
 
-using FileHandle = details::UVTypeWrapper<uv_file>;
-using OSSocketHandle = details::UVTypeWrapper<uv_os_sock_t>;
-using OSFileDescriptor = details::UVTypeWrapper<uv_os_fd_t>;
+using FileHandle = details::UVTypeWrapper<uv_file>; /*!< Utility class that wraps an internal file handle. */
+using OSSocketHandle = details::UVTypeWrapper<uv_os_sock_t>; /*!< Utility class that wraps an os socket handle. */
+using OSFileDescriptor = details::UVTypeWrapper<uv_os_fd_t>; /*!< Utility class that wraps an os file descriptor. */
 
 constexpr FileHandle StdIN{0}; /*!< Placeholder for stdin descriptor. */
 constexpr FileHandle StdOUT{1}; /*!< Placeholder for stdout descriptor. */
 constexpr FileHandle StdERR{2}; /*!< Placeholder for stderr descriptor. */
 
-using TimeSpec = uv_timespec_t;
-using Stat = uv_stat_t;
-using Uid = uv_uid_t;
-using Gid = uv_gid_t;
+using TimeSpec = uv_timespec_t; /*!< Library equivalent for uv_timespec_t. */
+using Stat = uv_stat_t; /*!< Library equivalent for uv_stat_t. */
+using Uid = uv_uid_t; /*!< Library equivalent for uv_uid_t. */
+using Gid = uv_gid_t; /*!< Library equivalent for uv_gid_t. */
 
-using TimeVal = uv_timeval_t;
-using RUsage = uv_rusage_t;
+using TimeVal = uv_timeval_t; /*!< Library equivalent for uv_timeval_t. */
+using RUsage = uv_rusage_t; /*!< Library equivalent for uv_rusage_t. */
 
 
 /**