Contents

TestClass Class

A test class demonstrating private member documentation. More...

Header: #include <TestClass>

Public Types

enum PublicEnum { PublicValue1, PublicValue2 }

Public Functions

TestClass()
void publicFunction()

Public Variables

int publicVariable

Protected Types

enum ProtectedEnum { ProtectedValue1, ProtectedValue2 }

Protected Functions

void protectedFunction()

Protected Variables

int protectedVariable

Private Types

enum PrivateEnum { PrivateValue1, PrivateValue2 }

Private Functions

void privateFunction()
void privateHelper()

Private Variables

bool privateBoolVar
int privateVariable
void relatedFunction(const TestClass &obj)
void swap(TestClass &a, TestClass &b)
bool operator==(const TestClass &lhs, const TestClass &rhs)

Detailed Description

This class contains documented members at all three access levels: public, protected, and private. It is used to test the includeprivate configuration option.

Member Type Documentation

enum TestClass::PrivateEnum

A private enumeration for internal use.

This enumeration is used internally by the class implementation. It should only appear in documentation when includeprivate is enabled.

ConstantValueDescription
TestClass::PrivateValue10First private value
TestClass::PrivateValue21Second private value

enum TestClass::ProtectedEnum

A protected enumeration.

ConstantValueDescription
TestClass::ProtectedValue10First protected value
TestClass::ProtectedValue21Second protected value

enum TestClass::PublicEnum

A public enumeration.

ConstantValueDescription
TestClass::PublicValue10First public value
TestClass::PublicValue21Second public value

Member Function Documentation

TestClass::TestClass()

Default constructor.

Creates a TestClass instance.

[private] void TestClass::privateFunction()

Private function for internal operations.

This function performs internal operations and should only be documented when includeprivate configuration is enabled.

[private] void TestClass::privateHelper()

Private helper function.

This is another private function to test multiple private function documentation.

[protected] void TestClass::protectedFunction()

Protected function.

This function is accessible to derived classes.

void TestClass::publicFunction()

Public function.

This function is publicly accessible.

Member Variable Documentation

bool TestClass::privateBoolVar

Another private variable.

This tests multiple private variable documentation.

int TestClass::privateVariable

Private variable for internal state.

This variable holds internal state and should only appear in documentation when includeprivate is enabled.

int TestClass::protectedVariable

Protected variable.

This variable is accessible to derived classes.

int TestClass::publicVariable

Public variable.

This variable is publicly accessible.

Related Non-Members

void relatedFunction(const TestClass &obj)

A related non-member function.

This function is related to TestClass but not a member. It takes obj as argument for shits and giggles.

void swap(TestClass &a, TestClass &b)

Hidden friend swap function.

Another hidden friend that should be publicly visible. It swaps a and b.

bool operator==(const TestClass &lhs, const TestClass &rhs)

Hidden friend equality operator.

This is a hidden friend function declared in the private section but actually has public visibility through ADL. It should appear in documentation regardless of includeprivate setting.

Returns either true or false, entirely dependent on the values of lhs and rhs.