More consistent default handling for StringOption

[alexxy/gromacs.git] / src / gromacs / options / basicoptions.h

diff --git a/src/gromacs/options/basicoptions.h b/src/gromacs/options/basicoptions.h
index c35ee9228bef1768e6a2a8b4b314d8905f0d3276..67f14e31d9414018c57e06deef57e00da2c586fe 100644 (file)
--- a/src/gromacs/options/basicoptions.h
+++ b/src/gromacs/options/basicoptions.h
@@ -364,7 +364,10 @@ class StringOption : public OptionTemplate<std::string, StringOption>
          * The index (zero-based) of the selected value in the array \p values
          * provided to enumValues() is written into \p *store after the
          * option gets its value.  If the option has not been provided,
-         * and there is no default value, -1 is stored.
+         * and there is no default value, -1 is stored.  If store(),
+         * storeVector() or defaultEnumIndex() is not present, the value in
+         * \p *store is kept as a default value, otherwise it is always
+         * overwritten.
          *
          * Cannot be specified without enumValue().
          *