Fix Doxygen warnings.
authorTeemu Murtola <teemu.murtola@gmail.com>
Mon, 22 Jul 2013 04:47:10 +0000 (07:47 +0300)
committerTeemu Murtola <teemu.murtola@gmail.com>
Mon, 22 Jul 2013 04:47:10 +0000 (07:47 +0300)
Ibf32de31 introduced some undocumented members into
gmx::BinaryInformationSettings, which were causing Doxygen warnings.
Jenkins does not catch these in legacyheaders/...

Related to #1209.

Change-Id: I3c5c0c9818966290d3b298422905604b136d01c3

src/gromacs/legacyheaders/copyrite.h

index daf13eb8e9cab44eae9d63a93869445a0c14d839..3fa237150fdcb9b17688e4bd326a76a9f844a81f 100644 (file)
@@ -95,16 +95,19 @@ class BinaryInformationSettings
             bCopyright_ = bEnabled;
             return *this;
         }
+        //! Print a header line with "Generated by" text (for output files).
         BinaryInformationSettings &generatedByHeader(bool bEnabled)
         {
             bGeneratedByHeader_ = bEnabled;
             return *this;
         }
+        //! Prefix each line with this string.
         BinaryInformationSettings &linePrefix(const char *prefix)
         {
             prefix_ = prefix;
             return *this;
         }
+        //! Suffix each line with this string.
         BinaryInformationSettings &lineSuffix(const char *suffix)
         {
             suffix_ = suffix;