Doc

Author: dmitry-ganyushin

dev-docs/source/EnumeratedString.rst

@@ -21,7 +21,7 @@ However, this is not allowed under C++.
 
 The ``EnumeratedString`` objects allow for binding an ``enum`` or ``enum class`` to a vector of strings, allowing for much
 of the same behavior.  This allows for easy-to-read ``if`` and ``switch`` statements, as well as easy conversions and assignments
-with strings from the allowed set.  This further adds an additional layer of validation for string properties, in additon to the
+with strings from the allowed set.  This further adds an additional layer of validation for string properties, in addition to the
 ``StringListValidator`` used in the property declaration.
 
 How to use the EnumeratedString

dev-docs/source/EnumeratedStringProperty.rst

@@ -0,0 +1,53 @@
+.. _EnumeratedStringProperty:
+
+What is EnumeratedStringProperty?
+---------------------------------
+
+``EnumeratedStringProperty`` allows the use of ``EnumeratedString`` objects within the Property structure framework.
+
+How to use the EnumeratedStringProperty
+---------------------------------------
+
+Include the ``EnumeratedStringProperty.h`` header file. Set up the ``EnumeratedStringProperty`` as follows:
+
+.. code-block:: cpp
+
+    namespace {
+        const std::vector<std::string> binningModeNames{"Default", "Linear", "Logarithmic", "ReverseLogarithmic", "Power"};
+        enum class BinningMode { DEFAULT, LINEAR, LOGARITHMIC, REVERSELOG, POWER, enum_count };
+        typedef Mantid::Kernel::EnumeratedString<BinningMode, &binningModeNames> BINMODE;
+    } // namespace
+
+Declare property:
+
+.. code-block:: cpp
+
+    declareProperty(
+        std::make_unique<EnumeratedStringProperty<BinningMode, &binningModeNames>>("PropertyName"),
+        "Description"
+    );
+
+Use declared property:
+
+.. code-block:: cpp
+
+    BINMODE binMode = someName;
+    if (binMode == BinningMode::LINEAR)
+        do_something();
+    else if (binMode != "Default")
+        do_something_else();
+
+Determining and using pre-set mode, if present, or using the default setting:
+
+.. code-block:: cpp
+
+    BINMODE binMode;
+    if (existsProperty("PropertyName"))
+        Mode = getPropertyValue("PropertyName");
+    else
+        Mode = "Default";
+
+Example Use of EnumeratedString
+-------------------------------
+
+Please see examples of usage in ``Rebin.cpp``, ``CalculateDIFC.cpp``, and ``AddSampleLog.cpp``.

dev-docs/source/index.rst

@@ -273,6 +273,7 @@ Component Overviews
 
    BatchWidget/index
    EnumeratedString
+   EnumeratedStringProperty
    EventWorkspaceDev
    HandlingXML
    IndexProperty