• C++ Classes
  • Test

    • Contents

    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

    Public Types

    struct Struct
    SomeType
    Specialized

    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 funcTemplate(T1 a, T2 b)
    void overload()
    void overload(bool b)
    bool operator==(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)

    Macros

    QDOCTEST_MACRO2(int &x)
    Q_INVOKABLE

    Detailed Description

    Member Type Documentation

    Test::SomeType

    A typedef.

    [alias] template<typename T> Test::Specialized

    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.

    [protected] template <typename T1, typename T2> void Test::funcTemplate(T1 a, T2 b)

    Function template with two parameters, a and b.

    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.

    Q_INVOKABLE

    This is a mock Q_INVOKABLE for the purpose of ensuring QDoc autolink to it as expected.