diff options
author | Luca Di Sera <luca.disera@qt.io> | 2023-08-03 11:58:14 +0200 |
---|---|---|
committer | Luca Di Sera <luca.disera@qt.io> | 2023-08-07 12:53:32 +0200 |
commit | 5212645b4665917019a96ba873d9e98c1a136b5f (patch) | |
tree | b821ab1bbc1cf685aacc03ea55167386ccd474c2 /src/qdoc/qdoc/src/qdoc/importrec.h | |
parent | 3192ffc53328e3a7f6c555fccd4f7f81d652839e (diff) |
QDoc: Reorganize src/qdoc/qdoc
"src/qdoc/qdoc" contains the source code for the QDoc executable, along
with the source code for QDoc's manual.
Those files initially lived all together under "/src/qdoc", but recent
rearregement of the "qdoc" directory have moved them one level deeper,
to make space for related-but-contained sibling projects under the
"src/qdoc" directory.
Along the lines of those recent changes, and to make space for tests to be
moved under the directory, the "src/qdoc/qdoc" directory
is reoganized to follow a similar structure to other projects in its
parent.
All of qdoc source code is now moved under "src/qdoc/qdoc/src/qdoc".
The source code for QDoc's manual is left under the "doc" directory in
"src/qdoc/qdoc/", to give it more visibility and to better separate
between changes to the source-code level documentation and the
additional documentation that the project provides.
The "CMakeLists.txt" in the "src/qdoc/qdoc" directory was modified to
refer to the new paths where necessary.
The "CMakeLists.txt" in the "test/auto/qdoc/" directory, which specify
certain test targets that depend on the paths in the modified qdoc
directory, was modified to respect the new structure.
`#include` directives that were affected by the new structure have been
modified to respect the new paths.
Change-Id: I8b939889d7134863a1d1a09a96446c2076ee5e58
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Diffstat (limited to 'src/qdoc/qdoc/src/qdoc/importrec.h')
-rw-r--r-- | src/qdoc/qdoc/src/qdoc/importrec.h | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/src/qdoc/qdoc/src/qdoc/importrec.h b/src/qdoc/qdoc/src/qdoc/importrec.h new file mode 100644 index 000000000..84f8f35ac --- /dev/null +++ b/src/qdoc/qdoc/src/qdoc/importrec.h @@ -0,0 +1,33 @@ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 + +#ifndef IMPORTREC_H +#define IMPORTREC_H + +#include <QtCore/qglobal.h> +#include <QtCore/qstring.h> + +#include <utility> + +QT_BEGIN_NAMESPACE + +struct ImportRec +{ + QString m_moduleName {}; + QString m_majorMinorVersion {}; + QString m_importUri {}; // subdirectory of module directory + + ImportRec(QString name, QString version, QString importUri) + : m_moduleName(std::move(name)), + m_majorMinorVersion(std::move(version)), + m_importUri(std::move(importUri)) + { + } + QString &name() { return m_moduleName; } + QString &version() { return m_majorMinorVersion; } + [[nodiscard]] bool isEmpty() const { return m_moduleName.isEmpty(); } +}; + +QT_END_NAMESPACE + +#endif // IMPORTREC_H |