[Cppunit-devel] A tiny documentation typo

[drkm <dar...@ya...>]

  Hello.

  There is a typo in the documentation of the `TestFixture´ class, on
<URL:http://cppunit.sf.net/class_cpp_unit_1_1_test_fixture.html>.  The
brief doc string of the dtor is

    \brief Set up context before running a test.

(note the "\brief").  I think (well, I suppose) that the Doxygen "//!"
form, as opposed to the "/*! */" one, is always brief.  That is what
the source seems to say :

    /*! \brief Wraps a test case with setUp and tearDown methods.
     * [...]
     */
    class CPPUNIT_API TestFixture
    {
    public:
      virtual ~TestFixture() {};

      //! \brief Set up context before running a test.
      virtual void setUp() {};

      //! Clean up after the test run.
      virtual void tearDown() {};
    };

  In the doc, the brief strings for both `TestFixture´ class and
`TestFixture::tearDown()´ member function are right, but not the one
for `TestFixture::~TestFixture()´.

  So I suppose you have to remove the "\brief" keyword in the doc
string for `TestFixture::~TestFixture()´.

  Hope it helps.

  Regards,

--drkm