DefaultDoc Class Reference

#include <defaultdoc.h>

Detailed Description

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

Result<void> CopyFrom(const MyClass& src);

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

Constructor & Destructor Documentation

DefaultDoc()

DefaultDoc ( )

default

Constructs a @CLASS object with default values.

Member Function Documentation

CopyFrom()

Result<void> CopyFrom

(

const DefaultDoc &

src

)

Makes this @CLASS a copy of src by copying the contents of src into this @CLASS.

Parameters

[in]

src

Another @CLASS to be used as source for the copy operation.

Returns

OK on success.

Reset()

void Reset

(

)

Resets this @CLASS to the state it has right after default construction. This includes freeing all resources held by this @CLASS.

GetHashCode()

HashInt GetHashCode

(

)

const

Returns the hash code of this @CLASS.

Returns

Hash code of this @CLASS.

GetUniqueHashCode()

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.

Returns

Hash value of this @CLASS.

operator==()

Bool operator==

(

const DefaultDoc &

other

)

const

Checks if this @CLASS equals other.

Parameters

[in]

other

Another @CLASS.

Returns

True if this equals other, false otherwise.

operator!=()

Bool operator!=

(

const DefaultDoc &

other

)

const

Checks if this @CLASS is not equal to other.

Parameters

[in]

other

Another @CLASS.

Returns

True if this is not equal to other, false otherwise.

operator<()

Bool operator<

(

const DefaultDoc &

other

)

const

Checks if this @CLASS is less than other.

Parameters

[in]

other

Another @CLASS.

Returns

True if this is less than other, false otherwise.

operator<=()

Bool operator<=

(

const DefaultDoc &

other

)

const

Checks if this @CLASS is less than or equal to other.

Parameters

[in]

other

Another @CLASS.

Returns

True if this is less than or equal to other, false otherwise.

operator>()

Bool operator>

(

const DefaultDoc &

other

)

const

Checks if this @CLASS is greater than other.

Parameters

[in]

other

Another @CLASS.

Returns

True if this is greater than other, false otherwise.

operator>=()

Bool operator>=

(

const DefaultDoc &

other

)

const

Checks if this @CLASS is greater than or equal to other.

Parameters

[in]

other

Another @CLASS.

Returns

True if this is greater than or equal to other, false otherwise.

Compare()

COMPARERESULT Compare

(

const DefaultDoc &

other

)

const

Compares this and other.

Parameters

[in]

other

Another @CLASS.

Returns

Result of the comparison.

ToString()

String ToString

(

const FormatStatement *

formatStatement = nullptr

)

const

Returns a String representation of this @CLASS.

Parameters

[in]

formatStatement

Nullptr or additional formatting instruction.

Returns

String representation of this @CLASS.