Test Class | TestCPP

- C++ Classes
- Test

# Test Class

class TestQDoc::Test

A class in a namespace. More...

Header: | #include <Test>
CMake: | find_package(Qt6 REQUIRED COMPONENTS QDocTest) target_link_libraries(mytarget PRIVATE Qt6::QDocTest)
qmake: | QT += testcpp
Inherited By: | TestQDoc::TestDerived

- List of all members, including inherited members
- Deprecated members

## Public Types

enum | ClassicEnum { Yee, Haw, Howdy, Partner }
enum class | ScopedEnum { This, That, All }
| SomeType

## Public Functions

| Test()
TestQDoc::Test & | operator=(TestQDoc::Test &&other)
void (*)(bool) | funcPtr(bool b, const char *s)
void | inlineFunction()
int | someFunction(int, int v = 0)
void | someFunctionDefaultArg(int i, bool b = false)
virtual void | virtualFun()

## Protected Functions

void | overload()
void | overload(bool b)

## Related Non-Members

bool | operator==(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)

## Macros

| QDOCTEST_MACRO2(int &x)

## Detailed Description

## Member Type Documentation

### enum Test::ClassicEnum

Constant | Value
--- | ---
`TestQDoc::Test::Yee` | `0`
`TestQDoc::Test::Haw` | `1`
`TestQDoc::Test::Howdy` | `2`
`TestQDoc::Test::Partner` | `3`

### enum class Test::ScopedEnum

Constant | Value | Description
--- | --- | ---
`TestQDoc::Test::ScopedEnum::This` | `0x01` | Something
`TestQDoc::Test::ScopedEnum::That` | `0x02` | Something else
`TestQDoc::Test::ScopedEnum::All` | `This | That` | Everything

A scoped enum.

### Test::SomeType

A typedef.

## Member Function Documentation

### `[protected]` void Test::overload()

### `[protected, since Test 1.2]` void Test::overload(bool b)

Overloads that share a documentation comment, optionally taking a parameter b.

### `[default]` Test::Test()

Default constructor.

### `[default]` TestQDoc::Test &Test::operator=(TestQDoc::Test &&other)

Move-assigns other.

### void (*)(bool) Test::funcPtr(bool b, const char *s)

Returns a pointer to a function that takes a boolean. Uses b and s.

### void Test::inlineFunction()

An inline function, documented using the \fn QDoc command.

### int Test::someFunction(int, int v = 0)

Function that takes a parameter v. Also returns the value of v.

### void Test::someFunctionDefaultArg(int i, bool b = false)

Function that takes a parameter i and b.

### `[virtual]` void Test::virtualFun()

Function that must be reimplemented.

## Related Non-Members

### bool operator==(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)

Returns true if lhs and rhs are equal.

## Macro Documentation

### `[since Test 1.1]` QDOCTEST_MACRO2(int &x)

A macro with argument x.

This macro was introduced in Test 1.1.