diff options
Diffstat (limited to 'include/cppunit/SourceLine.h')
| -rw-r--r-- | include/cppunit/SourceLine.h | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/include/cppunit/SourceLine.h b/include/cppunit/SourceLine.h index 4ef423a..5d2a3c1 100644 --- a/include/cppunit/SourceLine.h +++ b/include/cppunit/SourceLine.h @@ -4,7 +4,9 @@ #include <cppunit/Portability.h> #include <string> -/*! Constructs a SourceLine object initialized with the location where the macro is expanded. +/*! \brief Constructs a SourceLine object initialized with the location where the macro is expanded. + * \ingroup CreatingNewAssertions + * \relates CppUnit::SourceLine * Used to write your own assertion macros. * \see Asserter for example of usage. */ @@ -14,11 +16,14 @@ namespace CppUnit { -/*! \class SourceLine - * \brief This class represents the location of a line of text in a specified file. - * Use the CPPUNIT_SOURCELINE macro to construct that object. +/*! \brief Represents a source line location. + * \ingroup CreatingNewAssertions + * \ingroup BrowsingCollectedTestResult * * Used to capture the failure location in assertion. + * + * Use the CPPUNIT_SOURCELINE() macro to construct that object. Typically used when + * writing an assertion macro in association with Asserter. * * \see Asserter. */ |