From c7ddeff3fb37be9444ea62315eb1cb0c9fe4a32f Mon Sep 17 00:00:00 2001 From: karutoh Date: Thu, 1 Feb 2024 20:00:27 -0800 Subject: [PATCH] Type class is now documented. --- include/ehs/Type.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/include/ehs/Type.h b/include/ehs/Type.h index e5f862f..6fc7f61 100644 --- a/include/ehs/Type.h +++ b/include/ehs/Type.h @@ -17,6 +17,8 @@ namespace ehs public: Type(); + /// Constructs the object with the given class name. + /// @param [in] id The class name. explicit Type(const Char_8* id); Type(Type&& type) noexcept; @@ -39,12 +41,20 @@ namespace ehs bool operator!=(const Char_8* inStr) const; + /// Retrieves the name size. + /// @returns The size. UInt_64 GetSize() const; + /// Retrieves the name. + /// @returns The name. const Char_8* GetId() const; + /// Retrieves the hashed name. + /// @returns The hashed name. UInt_64 GetHashId() const; + /// Whether or not this object was properly constructed. + /// @returns The result. bool IsValid() const; private: