#include <defaultdoc.h>
The only purpose of this class is to be used in @copydoc commands for standard functions like CopyFrom or GetHashCode. For example to add a default documentation to a CopyFrom function of a class, write
Public Member Functions | |
DefaultDoc ()=default | |
Result< void > | CopyFrom (const DefaultDoc &src) |
void | Reset () |
HashInt | GetHashCode () const |
UniqueHash | GetUniqueHashCode () const |
Bool | operator== (const DefaultDoc &other) const |
Bool | operator!= (const DefaultDoc &other) const |
Bool | operator< (const DefaultDoc &other) const |
Bool | operator<= (const DefaultDoc &other) const |
Bool | operator> (const DefaultDoc &other) const |
Bool | operator>= (const DefaultDoc &other) const |
COMPARERESULT | Compare (const DefaultDoc &other) const |
String | ToString (const FormatStatement *formatStatement=nullptr) const |
|
default |
Constructs a @CLASS object with default values.
Result<void> CopyFrom | ( | const DefaultDoc & | src | ) |
void Reset | ( | ) |
Resets this @CLASS to the state it has right after default construction. This includes freeing all resources held by this @CLASS.
HashInt GetHashCode | ( | ) | const |
Returns the hash code of this @CLASS.
UniqueHash GetUniqueHashCode | ( | ) | const |
Returns the 128-bit hash value of this @CLASS. The implementation ensures uniform distribution, so for practical purposes you can safely assume that two objects are equal if their hash values are equal.
Bool operator== | ( | const DefaultDoc & | other | ) | const |
Bool operator!= | ( | const DefaultDoc & | other | ) | const |
Bool operator< | ( | const DefaultDoc & | other | ) | const |
Bool operator<= | ( | const DefaultDoc & | other | ) | const |
Bool operator> | ( | const DefaultDoc & | other | ) | const |
Bool operator>= | ( | const DefaultDoc & | other | ) | const |
COMPARERESULT Compare | ( | const DefaultDoc & | other | ) | const |
String ToString | ( | const FormatStatement * | formatStatement = nullptr | ) | const |