diff --git a/conversion/binaryconversion.h b/conversion/binaryconversion.h index fa08384..6f30edb 100644 --- a/conversion/binaryconversion.h +++ b/conversion/binaryconversion.h @@ -61,13 +61,6 @@ # error "Middle endian byte order is not supported!" #endif -/*! - * \namespace ConversionUtilities - * \brief Contains several functions providing conversions between different data types. - * - * binaryconversion.h declares functions which convert base data types to an array of bytes and vice versa. - * stringconversion.h declares different functions around string conversion such as converting a number to a string and vice versa. - */ namespace ConversionUtilities { diff --git a/conversion/stringconversion.cpp b/conversion/stringconversion.cpp index b91193d..e72cfc1 100644 --- a/conversion/stringconversion.cpp +++ b/conversion/stringconversion.cpp @@ -11,6 +11,13 @@ using namespace std; +/*! + * \namespace ConversionUtilities + * \brief Contains several functions providing conversions between different data types. + * + * binaryconversion.h declares functions which convert base data types to an array of bytes and vice versa. + * stringconversion.h declares different functions around string conversion such as converting a number to a string and vice versa. + */ namespace ConversionUtilities { diff --git a/conversion/widen.h b/conversion/widen.h index 301ee5a..1aff6b1 100644 --- a/conversion/widen.h +++ b/conversion/widen.h @@ -14,6 +14,7 @@ namespace ConversionUtilities /*! * \brief Converts a std::string to a wide string using the specified locale. + * \deprecated Might be removed in future release because not used anymore. Use iconv based string converion functions instead. */ template, class A = std::allocator > class CPP_UTILITIES_EXPORT Widen : public std::unary_function > diff --git a/io/copy.h b/io/copy.h index 23cefdc..c6b508a 100644 --- a/io/copy.h +++ b/io/copy.h @@ -34,8 +34,8 @@ CopyHelper::CopyHelper() /*! * \brief Copies \a count bytes from \a input to \a output. - * \remarks Set an exception mask using std::ios::exceptions() to get - * a std::ios_base::failure exception when an IO error occurs. + * \remarks Set an exception mask using std::ios::exceptions() to get a std::ios_base::failure exception + * when an IO error occurs. */ template void CopyHelper::copy(std::istream &input, std::ostream &output, std::size_t count) @@ -51,16 +51,19 @@ void CopyHelper::copy(std::istream &input, std::ostream &output, std /*! - * \brief Copies \a count bytes from \a input to \a output. The procedure might be abortet. Progress updates will be reportet. + * \brief Copies \a count bytes from \a input to \a output. The procedure might be aborted and + * progress updates will be reported. * - * Copying is aborted when \a isAborted returns true. The current progress is reported by calling the specified \a callback function. + * Copying is aborted when \a isAborted returns true. The current progress is reported by calling + * the specified \a callback function. * - * \remarks Set an exception mask using std::ios::exceptions() to get a std::ios_base::failure exception when an IO error occurs. + * \remarks Set an exception mask using std::ios::exceptions() to get a std::ios_base::failure exception + * when an IO error occurs. */ template void CopyHelper::callbackCopy(std::istream &input, std::ostream &output, std::size_t count, const std::function &isAborted, const std::function &callback) { - std::size_t totalBytes = count; + const std::size_t totalBytes = count; while(count > bufferSize) { input.read(m_buffer, bufferSize); output.write(m_buffer, bufferSize); diff --git a/io/path.cpp b/io/path.cpp index 5ef1484..68630ee 100644 --- a/io/path.cpp +++ b/io/path.cpp @@ -90,7 +90,7 @@ void removeInvalidChars(std::string &fileName) * \param applicationDirectoryName Specifies the name for the application subdirectory. * \param createApplicationDirectory Indicates wheter the application subdirectory should be created if not present. * \returns Returns whether a settings directory could be located. - * \deprecated This function has FIXMEs. Since it is not used actually also a good candidate for being removed. + * \deprecated This function has FIXMEs. Since it is not used a good candidate for being removed. */ bool settingsDirectory(std::string &result, std::string applicationDirectoryName, bool createApplicationDirectory) { diff --git a/misc/random.cpp b/misc/random.cpp index 957b27a..2dd441a 100644 --- a/misc/random.cpp +++ b/misc/random.cpp @@ -12,6 +12,7 @@ using namespace std; /*! * \namespace RandomUtilities * \brief Contains utility functions for generating random character sequences. + * \deprecated Might be removed in future release because API is bad and it is not used anymore anyways. */ namespace RandomUtilities { @@ -25,7 +26,7 @@ const char symbols[24] = "!\"$%&/()=?'#*+~-_><.:,;"; /*! * \brief Generates a random character sequence using the given \a randomizer. - * \remarks Might be removed because not used anymore. + * \deprecated Might be removed in future release because API is bad and it is not used anymore anyways. */ void generateRandomCharacterSequence(char *result, unsigned int length, std::function randomizer, int highestRandomNumber, bool useSmallLetters, bool useCapitalLetters, bool useNumbers, bool useSymbols, bool useAtLeastOneOfEachCategory) { @@ -114,7 +115,7 @@ void generateRandomCharacterSequence(char *result, unsigned int length, std::fun /*! * \brief Generates a random character sequence using std::rand(). - * \remarks Might be removed because not used anymore. + * \deprecated Might be removed in future release because API is bad and it is not used anymore anyways. */ void generateRandomCharacterSequence(char *result, unsigned int length, bool useSmallLetters, bool useCapitalLetters, bool useNumbers, bool useSymbols, bool useAtLeastOneOfEachCategory) { diff --git a/misc/traits.h b/misc/traits.h index 3236f58..009cbfe 100644 --- a/misc/traits.h +++ b/misc/traits.h @@ -3,11 +3,14 @@ #include +/// \brief Contains traits for conveniently exploiting SFINAE. namespace Traits { +/// \cond namespace Detail { enum class Enabler {}; } +/// \endcond template using Conditional = typename std::conditional::type;