From c174a95622437ec97e1b0a0d491577e0d7f98a95 Mon Sep 17 00:00:00 2001 From: Leonetienne Date: Sun, 27 Feb 2022 14:33:54 +0100 Subject: [PATCH] Added documentation for Ord --- Src/GeneralUtility.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Src/GeneralUtility.h b/Src/GeneralUtility.h index b1ab230..e3a0f85 100644 --- a/Src/GeneralUtility.h +++ b/Src/GeneralUtility.h @@ -6,6 +6,12 @@ class GeneralUtility { public: + //! Will return the index of `item` in `set`. + //! \tparam T_Type The type of `item` + //! \tparam T_Container The type of container + //! \param item The item to find the index for + //! \param set The container to be looking in + //! \return The index of `item` in `set`. -1 if not found. template static int Ord(const T_Type& item, const T_Container& set); private: