From 19c58e33c4bd460ff8b7c2fc4cafbaa47938eaac Mon Sep 17 00:00:00 2001
From: Markus Blatt <markus@dr-blatt.de>
Date: Fri, 24 Jun 2022 12:16:46 +0200
Subject: [PATCH] Document at least what OrderedMap class is all about.

---
 opm/input/eclipse/EclipseState/Util/OrderedMap.hpp | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/opm/input/eclipse/EclipseState/Util/OrderedMap.hpp b/opm/input/eclipse/EclipseState/Util/OrderedMap.hpp
index cf60d2624..b1f9f152a 100644
--- a/opm/input/eclipse/EclipseState/Util/OrderedMap.hpp
+++ b/opm/input/eclipse/EclipseState/Util/OrderedMap.hpp
@@ -100,6 +100,16 @@ struct TruncatedStringEquals<std::string::npos> : public std::equal_to<std::stri
 
 } // end namespace detail
 
+/// \brief A map with iteration in the order of insertion.
+///
+/// Each entry has an associated index indicating when a value with that key was
+/// first inserted. When itering over it's entries values with lower insertion index
+/// are traversed before ones with an higher insertion index.
+///
+/// \tparam MAX_CHARS The maximum number of characters that are use a keys. Default is
+///                   std::string::npos, which honors all characters. Any keys with the
+///                   same first MAX_CHARS characters are considered equal.
+///
 template <typename T, std::size_t MAX_CHARS = std::string::npos>
 class OrderedMap {
 public: