diff --git a/CMakeLists.txt b/CMakeLists.txt index 387c9114..5262bdd3 100644 --- a/CMakeLists.txt +++ b/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( diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 6fd0f466..275a5f7c 100644 --- a/docs/CMakeLists.txt +++ b/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) diff --git a/docs/doxy.in b/docs/doxy.in index 886d79e3..8dc6ca3e 100644 --- a/docs/doxy.in +++ b/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. diff --git a/docs/extra.dox b/docs/extra.dox new file mode 100644 index 00000000..106afd84 --- /dev/null +++ b/docs/extra.dox @@ -0,0 +1,5 @@ +/** + * @namespace uvw + * + * @brief `uvw` default namespace. + */ diff --git a/src/uvw/util.hpp b/src/uvw/util.hpp index 1425f32f..fb7e023f 100644 --- a/src/uvw/util.hpp +++ b/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; -using OSSocketHandle = details::UVTypeWrapper; -using OSFileDescriptor = details::UVTypeWrapper; +using FileHandle = details::UVTypeWrapper; /*!< Utility class that wraps an internal file handle. */ +using OSSocketHandle = details::UVTypeWrapper; /*!< Utility class that wraps an os socket handle. */ +using OSFileDescriptor = details::UVTypeWrapper; /*!< 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. */ /**