Type class is now documented.

This commit is contained in:
Arron David Nelson 2024-02-01 20:00:27 -08:00
parent 227188243e
commit c7ddeff3fb

View File

@ -17,6 +17,8 @@ namespace ehs
public: public:
Type(); Type();
/// Constructs the object with the given class name.
/// @param [in] id The class name.
explicit Type(const Char_8* id); explicit Type(const Char_8* id);
Type(Type&& type) noexcept; Type(Type&& type) noexcept;
@ -39,12 +41,20 @@ namespace ehs
bool operator!=(const Char_8* inStr) const; bool operator!=(const Char_8* inStr) const;
/// Retrieves the name size.
/// @returns The size.
UInt_64 GetSize() const; UInt_64 GetSize() const;
/// Retrieves the name.
/// @returns The name.
const Char_8* GetId() const; const Char_8* GetId() const;
/// Retrieves the hashed name.
/// @returns The hashed name.
UInt_64 GetHashId() const; UInt_64 GetHashId() const;
/// Whether or not this object was properly constructed.
/// @returns The result.
bool IsValid() const; bool IsValid() const;
private: private: