blob: f33a6a83c347232515dec2d5b818e7dda39ac6d6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "testcpp.h"
namespace TestQDoc {
/*!
\module TestCPP
\qtvariable testcpp
\title QDoc Test C++ Classes
\brief A test module page.
*/
/*!
\namespace TestQDoc
\inheaderfile TestCPP
\inmodule TestCPP
\brief A namespace.
\section1 Usage
This namespace is for testing QDoc output.
*/
/*!
\class TestQDoc::Test
\inmodule TestCPP
\brief A class in a namespace.
*/
/*!
\class TestQDoc::TestDerived
\inmodule TestCPP
\brief A derived class in a namespace.
*/
/*!
\macro QDOCTEST_MACRO
\relates TestQDoc
*/
/*!
\macro QDOCTEST_MACRO2(x)
\relates TestQDoc::Test
\since Test 1.1
\brief A macro with argument \a x.
*/
/*!
\deprecated
Use someFunction() instead.
*/
void Test::deprecatedMember()
{
return;
}
/*!
\obsolete
Use someFunction() instead.
*/
void Test::obsoleteMember()
{
return;
}
/*!
\obsolete
Use obsoleteMember() instead.
*/
void Test::anotherObsoleteMember()
{
return;
}
/*!
Function that takes a parameter \a i and \a b.
*/
void Test::someFunctionDefaultArg(int i, bool b = false)
{
return;
}
/*!
Function that takes a parameter \a v.
Also returns the value of \a v.
*/
int Test::someFunction(int v)
{
return v;
}
/*!
\fn void TestQDoc::Test::inlineFunction()
\brief An inline function, documented using the \CMDFN QDoc command.
*/
/*!
Function that must be reimplemented.
*/
void Test::virtualFun()
{
return;
}
/*!
\reimp
*/
void TestDerived::virtualFun()
{
return;
}
/*!
\fn TestQDoc::Test::overload()
\fn TestQDoc::Test::overload(bool b)
Overloads that share a documentation comment, optionally taking
a parameter \a b.
*/
} // namespace TestQDoc
|
