TestQDoc Namespace

A namespace. More...

Header: #include <TestCPP>
CMake: find_package(Qt6 REQUIRED COMPONENTS QDocTest)
target_link_libraries(mytarget PRIVATE Qt6::QDocTest)
qmake: QT += testcpp
Since: Qt 2.0

Classes

(since 1.1) class Test
(since 2.0) class TestDerived
(since 2.0) class Vec

Variables

(since Test 1.2) int QDOCTEST_GLOBAL_VARIABLE

Macros

(since Test 1.4)
(since Test 1.3) QDOCTEST_CONDITIONAL_MACRO
(since Test 0.9) QDOCTEST_MACRO
(since Test 1.4) QDOCTEST_SHARED_MACRO_A(x)
(since Test 1.4) QDOCTEST_SHARED_MACRO_B(x)

Detailed Description

Usage

This namespace is for testing QDoc output.

Classes

class Test

A class in a namespace. More...

class TestDerived

A class in a namespace, derived from Test. More...

class Vec

Type alias that has its own reference. More...

Variable Documentation

[since Test 1.2] int QDOCTEST_GLOBAL_VARIABLE

This variable holds a test variable for since documentation.

This variable was introduced in Test 1.2.

Macro Documentation

[since Test 1.4] QDOCTEST_SHARED_MACRO_A(x)

[since Test 1.4] QDOCTEST_SHARED_MACRO_B(x)

These macros perform simple arithmetic operations on x. QDOCTEST_SHARED_MACRO_A increments the value by 1. QDOCTEST_SHARED_MACRO_B decrements the value by 1.

These macros share documentation to test plural form in \since text.

These macros were introduced in Test 1.4.

[since Test 1.3] QDOCTEST_CONDITIONAL_MACRO

Test conditional macro documented separately from its definition. This replicates the Qt pattern where macros are defined in headers but documented in cpp files.

This macro was introduced in Test 1.3.

[since Test 0.9] QDOCTEST_MACRO

This macro was introduced in Test 0.9.