diff options
author | Topi Reinio <topi.reinio@qt.io> | 2019-09-04 14:14:01 +0200 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2019-09-05 00:05:28 +0200 |
commit | 2174b1a34a0754376b77528161bf2328855cb0e7 (patch) | |
tree | 97fc366a0a59d02287cf651eed19af33349bab46 /tests/auto/qdoc/generatedoutput/testcpp.cpp | |
parent | f51776c427b268caf348efa524264c5e25e31a18 (diff) |
Add an initial test case for C++ documentation generated by QDoc
This will be expanded later on. The minimal C++ project tests QDoc's
HTML output for a module page, namespace and class reference, and
some class members.
Change-Id: Ifabc394116b675152d3ac95dc96a46e6e9c768ec
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'tests/auto/qdoc/generatedoutput/testcpp.cpp')
-rw-r--r-- | tests/auto/qdoc/generatedoutput/testcpp.cpp | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/tests/auto/qdoc/generatedoutput/testcpp.cpp b/tests/auto/qdoc/generatedoutput/testcpp.cpp new file mode 100644 index 000000000..12698c9d6 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/testcpp.cpp @@ -0,0 +1,73 @@ +/**************************************************************************** +** +** 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 + \title QDoc Test C++ Classes + \brief A test module page. +*/ + +/*! + \namespace TestQDoc + \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. +*/ + +/*! + \macro QDOCTEST_MACRO + \relates TestQDoc +*/ + +/*! + 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. +*/ + +} // namespace TestQDoc |