diff --git a/application/argumentparser.cpp b/application/argumentparser.cpp index 5ef3bd6..ef85d65 100644 --- a/application/argumentparser.cpp +++ b/application/argumentparser.cpp @@ -439,7 +439,7 @@ inline bool notEmpty(const char *str) /// \endcond /*! - * \class ApplicationUtilities::Argument + * \class Argument * \brief The Argument class is a wrapper for command line argument information. * * Instaces of the Argument class are used as definition when parsing command line @@ -710,7 +710,7 @@ void Argument::resetRecursively() } /*! - * \class ApplicationUtilities::ArgumentParser + * \class ArgumentParser * \brief The ArgumentParser class provides a means for handling command line arguments. * * To setup the parser create instances of ApplicationUtilities::Argument to define a @@ -719,7 +719,7 @@ void Argument::resetRecursively() * To invoke parsing call parseArgs(). The parser will verify the previously * assigned definitions (and might throw std::invalid_argument) and then parse the * given command line arguments according the definitions (and might throw - * ApplicationUtilities::Failure). + * CppUtilities::Failure). */ /*! @@ -878,7 +878,7 @@ void ArgumentParser::printHelp(ostream &os) const * - This method will not return in the error case if the ParseArgumentBehavior::ExitOnFailure is present * (default). * - This method will not return in case shell completion is requested. This behavior can be altered - * by overriding ApplicationUtilities::exitFunction which defaults to &std::exit. + * by overriding CppUtilities::exitFunction which defaults to &std::exit. * \throws Throws Failure if the specified arguments are invalid and the ParseArgumentBehavior::ExitOnFailure * flag is *not* present. * \sa parseArgs(), readArgs(), parseArgsOrExit() @@ -913,7 +913,7 @@ void ArgumentParser::parseArgs(int argc, const char *const *argv, ParseArgumentB * - In contrast to parseArgs() this method does not check whether constraints are violated and it * does not call any callbacks. * - This method will not return in case shell completion is requested. This behavior can be altered - * by overriding ApplicationUtilities::exitFunction which defaults to &std::exit. + * by overriding CppUtilities::exitFunction which defaults to &std::exit. * \throws Throws Failure if the specified arguments are invalid. * \sa parseArgs(), parseArgsOrExit() * \deprecated In next major release, this method will be private. parseArgs() can serve the same diff --git a/application/argumentparser.h b/application/argumentparser.h index ccddd3d..1745281 100644 --- a/application/argumentparser.h +++ b/application/argumentparser.h @@ -75,7 +75,7 @@ using ArgumentPredicate = std::function; enum class UnknownArgumentBehavior { Ignore, /**< Unknown arguments are ignored without warnings. */ Warn, /**< A warning is printed to std::cerr if an unknown argument is detected. */ - Fail /**< Further parsing is aborted and an ApplicationUtilities::Failure instance with an error message is thrown. */ + Fail /**< Further parsing is aborted and a Failure instance with an error message is thrown. */ }; /*! diff --git a/conversion/conversionexception.h b/conversion/conversionexception.h index 14bdde9..950362f 100644 --- a/conversion/conversionexception.h +++ b/conversion/conversionexception.h @@ -17,7 +17,7 @@ public: }; /*! - * \class ConversionUtilities::ConversionException + * \class ConversionException * \brief The ConversionException class is thrown by the various conversion * functions of this library when a conversion error occurs. */ diff --git a/io/ansiescapecodes.cpp b/io/ansiescapecodes.cpp index 503e6c0..3644b56 100644 --- a/io/ansiescapecodes.cpp +++ b/io/ansiescapecodes.cpp @@ -15,9 +15,9 @@ namespace EscapeCodes { * The default value can be configured at build time by setting the CMake variable ENABLE_ESCAPE_CODES_BY_DEFAULT. * The "default for the default" is true. * However, the default is overridden with the value of the environment variable ENABLE_ESCAPE_CODES when instantiating - * an ApplicationUtilities::NoColorArgument (if ENABLE_ESCAPE_CODES is present). + * a NoColorArgument (if ENABLE_ESCAPE_CODES is present). * - * \sa ApplicationUtilities::NoColorArgument + * \sa NoColorArgument */ bool enabled = #ifdef CPP_UTILITIES_ESCAPE_CODES_ENABLED_BY_DEFAULT diff --git a/io/binaryreader.h b/io/binaryreader.h index 6afafb1..49fd4cd 100644 --- a/io/binaryreader.h +++ b/io/binaryreader.h @@ -564,7 +564,7 @@ inline uint8_t BinaryReader::readByte() /*! * \brief Reads a boolean value from the current stream and advances the current position of the stream by one byte. - * \sa IoUtilities::BitReader + * \sa BitReader */ inline bool BinaryReader::readBool() { @@ -651,7 +651,7 @@ inline void BinaryReader::read(std::uint8_t &oneByte) /*! * \brief Reads a boolean value from the current stream and advances the current position of the stream by one byte. - * \sa IoUtilities::BitReader + * \sa BitReader */ inline void BinaryReader::read(bool &oneBool) { diff --git a/io/bitreader.cpp b/io/bitreader.cpp index a80ab93..8d147a7 100644 --- a/io/bitreader.cpp +++ b/io/bitreader.cpp @@ -5,7 +5,7 @@ using namespace std; namespace CppUtilities { /*! - * \class IoUtilities::BitReader + * \class BitReader * \brief The BitReader class provides bitwise reading of buffered data. */ diff --git a/io/copy.h b/io/copy.h index fd34e7f..5c7b309 100644 --- a/io/copy.h +++ b/io/copy.h @@ -9,7 +9,7 @@ namespace CppUtilities { /*! - * \class IoUtilities::CopyHelper + * \class CopyHelper * \brief The CopyHelper class helps to copy bytes from one stream to another. * \tparam Specifies the buffer size. */ diff --git a/misc/parseerror.cpp b/misc/parseerror.cpp index b054706..771c54d 100644 --- a/misc/parseerror.cpp +++ b/misc/parseerror.cpp @@ -7,10 +7,10 @@ namespace CppUtilities { /*! - * \class ApplicationUtilities::ParseError + * \class ParseError * \brief The ParseError class is thrown by an ArgumentParser when a parsing error occurs. * \remarks The class might be used in other parsers, too. - * \sa ApplicationUtilities::ArgumentParser + * \sa ArgumentParser */ /*! diff --git a/tests/chronotests.cpp b/tests/chronotests.cpp index 955c0cf..94c7d79 100644 --- a/tests/chronotests.cpp +++ b/tests/chronotests.cpp @@ -59,7 +59,7 @@ static_assert(TimeSpan::fromDays(1.5).totalHours() == 36.0, "totalHours()"); static_assert(TimeSpan::fromDays(20.5).totalDays() == 20.5, "totalDays()"); /*! - * \brief The ChronoTests class tests classes and methods of the ChronoUtilities namespace. + * \brief The ChronoTests class tests classes and functions provided by the files inside the chrono directory. * \remarks Before comitting any changes to this test, run with different timezones to prevent * mistakes like timezone-dependent checks. (Eg. set environment variable TZ to different * values like 'UTC' or 'America/Los_Angeles'.) diff --git a/tests/conversiontests.cpp b/tests/conversiontests.cpp index 13ce897..371ab9f 100644 --- a/tests/conversiontests.cpp +++ b/tests/conversiontests.cpp @@ -25,7 +25,7 @@ static_assert(swapOrder(static_cast(0xABCDEF12)) == 0x12EFCDAB, " static_assert(swapOrder(static_cast(0xABCDEF1234567890)) == 0x9078563412EFCDAB, "swapOrder(uint64)"); /*! - * \brief The ConversionTests class tests classes and methods of the ConversionUtilities namespace. + * \brief The ConversionTests class tests classes and functions provided by the files inside the conversion directory. */ class ConversionTests : public TestFixture { CPPUNIT_TEST_SUITE(ConversionTests); diff --git a/tests/iotests.cpp b/tests/iotests.cpp index fd3dab6..7a47e6e 100644 --- a/tests/iotests.cpp +++ b/tests/iotests.cpp @@ -36,7 +36,7 @@ using namespace CppUtilities::Literals; using namespace CPPUNIT_NS; /*! - * \brief The IoTests class tests classes and methods of the IoUtilities namespace. + * \brief The IoTests class tests classes and functions provided by the files inside the io directory. */ class IoTests : public TestFixture { CPPUNIT_TEST_SUITE(IoTests); diff --git a/tests/mathtests.cpp b/tests/mathtests.cpp index 3dd28b8..fe581cb 100644 --- a/tests/mathtests.cpp +++ b/tests/mathtests.cpp @@ -24,7 +24,7 @@ static_assert(max(3, -2, 4, 2, 1) == 4, "max"); } // namespace CppUtilities /*! - * \brief The MathTests class tests functions of the MathUtilities namespace. + * \brief The MathTests class tests functions provided by misc/math.h. */ class MathTests : public TestFixture { CPPUNIT_TEST_SUITE(MathTests);