Skip to content

Commit

Permalink
Merge pull request mantidproject#36286 from mantidproject/patch-enume…
Browse files Browse the repository at this point in the history
…rated-string2

fix broken dev docs
  • Loading branch information
SilkeSchomann committed Oct 17, 2023
2 parents c47df2f + 9c10f80 commit b04ee55
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions dev-docs/source/EnumeratedString.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,11 @@ number of elements inside the ``enum``, and used for verifying compatibility wit
will be triggered if this is not included.

Further, the ``enum`` *must* have elements in order from 0 to :code:`enum_count`. That is, you *CANNOT* set them like so:

.. code-block:: cpp
enum class CakeTypeEnum : char {LEMON='l', BUNDT='b', POUND='p', enum_count=3}; // NOT ALLOWED
as this will break validation features inside the class.

Notice the use of the reference operator, :code:`&cakeTypeNames`, and *not* :code:`cakeTypeNames`.
Expand Down

0 comments on commit b04ee55

Please sign in to comment.