Fix most warnings with Doxygen 1.8.1.1.
authorTeemu Murtola <teemu.murtola@gmail.com>
Sun, 14 Oct 2012 06:43:05 +0000 (09:43 +0300)
committerTeemu Murtola <teemu.murtola@gmail.com>
Mon, 15 Oct 2012 15:13:40 +0000 (18:13 +0300)
Some of these seem bugs in Doxygen, but these changes shouldn't hurt.

Change-Id: Ifcb58df2f33e3fe0b6e4e51c02fbefe11162c9ae

src/gromacs/options/optionstoragetemplate.h
src/gromacs/utility/file.h
src/gromacs/utility/stringutil.h
src/testutils/refdata.h

index e6f79c24a1e88dab019cb7761eb41b486c1d3fd1..c777c4950cc822f60fdf8438dccb679359221b6a 100644 (file)
@@ -143,7 +143,7 @@ class OptionStorageTemplate : public AbstractOptionStorage
         virtual void processSetValues(ValueList *values)
         {
         }
-        /*! \copydoc AbstractOptionStorage::processSet()
+        /*! \copydoc gmx::AbstractOptionStorage::processSet()
          *
          * OptionStorageTemplate implements transaction support for a set of
          * values in this method (see the class description), and provides a
@@ -153,7 +153,7 @@ class OptionStorageTemplate : public AbstractOptionStorage
          * necessary.
          */
         virtual void processSet();
-        /*! \copydoc AbstractOptionStorage::processAll()
+        /*! \copydoc gmx::AbstractOptionStorage::processAll()
          *
          * The implementation in OptionStorageTemplate does nothing.
          */
index c2d54370c8aaa7912d22539a8470e761d1f444ee..68869c5aa768681ff9255152b687190dbd12fba9 100644 (file)
@@ -132,13 +132,13 @@ class File
          * Terminating newline will be present in \p line if it was present in
          * the file.
          * To loop over all lines in the file, use:
-         * \code
+\code
 std::string line;
 while (file.readLine(&line))
 {
     // ...
 }
-         * \endcode
+\endcode
          */
         bool readLine(std::string *line);
 
index 0dd731771be673aa23b736acc37919f5f60c1cda..417ea2fce2ff7bf9d1c5bc1d6b6b5a3aafb01914 100644 (file)
@@ -395,7 +395,7 @@ class TextLineWrapper
          * space.
          *
          * To iterate over lines in a string, use the following code:
-         * \code
+\code
 gmx::TextLineWrapper wrapper;
 // <set desired wrapping settings>
 size_t lineStart = 0;
@@ -408,7 +408,7 @@ while (lineStart < length)
     lineStart = nextLineStart;
 }
 return result;
-         * \endcode
+\endcode
          *
          * Does not throw.
          */
index ad98c260a81d88c4f02752d763d0de8e58b70384..558af2686759ab7fe3f200d6276e441eaecac27e 100644 (file)
@@ -250,12 +250,12 @@ class TestReferenceChecker
          *
          * The main use of this method is to assign meaning for missing
          * reference data.  Example use:
-         * \code
+\code
 if (checker.checkPresent(bHaveVelocities, "Velocities"))
 {
     // <check the velocities>
 }
-         * \endcode
+\endcode
          */
         bool checkPresent(bool bPresent, const char *id);