From ec53cf339d9f4a3be538465d15f4ff023cc4db10 Mon Sep 17 00:00:00 2001 From: Martchus Date: Wed, 27 Jul 2016 18:16:04 +0200 Subject: [PATCH] Improve doc --- conversion/binaryconversion.h | 4 ++-- io/ansiescapecodes.h | 3 ++- misc/memory.h | 4 ++++ 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/conversion/binaryconversion.h b/conversion/binaryconversion.h index adaea6c..3762453 100644 --- a/conversion/binaryconversion.h +++ b/conversion/binaryconversion.h @@ -72,7 +72,7 @@ namespace ConversionUtilities { /*! - * \brief Encapsulates functions using the big endian byte order. + * \brief Encapsulates binary conversion functions using the big endian byte order. * \sa Endianness - Wikipedia */ namespace BE { @@ -88,7 +88,7 @@ namespace BE { } /*! - * \brief Encapsulates functions using the little endian byte order. + * \brief Encapsulates binary conversion functions using the little endian byte order. * \sa Endianness - Wikipedia */ namespace LE { diff --git a/io/ansiescapecodes.h b/io/ansiescapecodes.h index a0cb0e4..4ad4356 100644 --- a/io/ansiescapecodes.h +++ b/io/ansiescapecodes.h @@ -6,7 +6,8 @@ #include /*! - * \brief Encapsulates ANSI escape codes. + * \brief Encapsulates functions for formatted terminal output using ANSI escape codes. + * \remarks The functions haven't been tested yet and are still experimental. API/ABI might change in next minor release. */ namespace EscapeCodes { diff --git a/misc/memory.h b/misc/memory.h index c34702c..a7e773d 100644 --- a/misc/memory.h +++ b/misc/memory.h @@ -3,6 +3,8 @@ #include +/// \cond + #if __cplusplus <= 201103L #define __cpp_lib_make_unique 201304 namespace std { @@ -37,5 +39,7 @@ namespace std { } #endif +/// \endcond + #endif // MEMORY_H