summaryrefslogtreecommitdiffstats
path: root/src/qdoc/doc.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/qdoc/doc.h')
-rw-r--r--src/qdoc/doc.h119
1 files changed, 0 insertions, 119 deletions
diff --git a/src/qdoc/doc.h b/src/qdoc/doc.h
deleted file mode 100644
index 8008025c7..000000000
--- a/src/qdoc/doc.h
+++ /dev/null
@@ -1,119 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2021 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$
-**
-****************************************************************************/
-
-#ifndef DOC_H
-#define DOC_H
-
-#include "location.h"
-
-#include "docutilities.h"
-#include "topic.h"
-
-#include <QtCore/qmap.h>
-#include <QtCore/qset.h>
-#include <QtCore/qstring.h>
-
-QT_BEGIN_NAMESPACE
-
-class Atom;
-class CodeMarker;
-class DocPrivate;
-class Quoter;
-class Text;
-
-typedef QPair<QString, QString> ArgPair;
-typedef QList<ArgPair> ArgList;
-typedef QMultiMap<QString, QString> QStringMultiMap;
-
-class Doc
-{
-public:
- // the order is important
- enum Sections {
- NoSection = -1,
- Section1 = 1,
- Section2 = 2,
- Section3 = 3,
- Section4 = 4
- };
-
- Doc() = default;
- Doc(const Location &start_loc, const Location &end_loc, const QString &source,
- const QSet<QString> &metaCommandSet, const QSet<QString> &topics);
- Doc(const Doc &doc);
- ~Doc();
-
- Doc &operator=(const Doc &doc);
-
- [[nodiscard]] const Location &location() const;
- [[nodiscard]] const Location &startLocation() const;
- [[nodiscard]] bool isEmpty() const;
- [[nodiscard]] const QString &source() const;
- [[nodiscard]] const Text &body() const;
- [[nodiscard]] Text briefText(bool inclusive = false) const;
- [[nodiscard]] Text trimmedBriefText(const QString &className) const;
- [[nodiscard]] Text legaleseText() const;
- [[nodiscard]] QSet<QString> parameterNames() const;
- [[nodiscard]] QStringList enumItemNames() const;
- [[nodiscard]] QStringList omitEnumItemNames() const;
- [[nodiscard]] QSet<QString> metaCommandsUsed() const;
- [[nodiscard]] TopicList topicsUsed() const;
- [[nodiscard]] ArgList metaCommandArgs(const QString &metaCommand) const;
- [[nodiscard]] QList<Text> alsoList() const;
- [[nodiscard]] bool hasTableOfContents() const;
- [[nodiscard]] bool hasKeywords() const;
- [[nodiscard]] bool hasTargets() const;
- [[nodiscard]] bool isInternal() const;
- [[nodiscard]] bool isMarkedReimp() const;
- [[nodiscard]] const QList<Atom *> &tableOfContents() const;
- [[nodiscard]] const QList<int> &tableOfContentsLevels() const;
- [[nodiscard]] const QList<Atom *> &keywords() const;
- [[nodiscard]] const QList<Atom *> &targets() const;
- [[nodiscard]] QStringMultiMap *metaTagMap() const;
-
- static void initialize();
- static void terminate();
- static QString alias(const QString &english);
- static void trimCStyleComment(Location &location, QString &str);
- static QString resolveFile(const Location &location, const QString &fileName,
- QString *userFriendlyFilePath = nullptr);
- static CodeMarker *quoteFromFile(const Location &location, Quoter &quoter,
- const QString &fileName);
- static QString canonicalTitle(const QString &title);
-
-private:
- void detach();
- DocPrivate *m_priv { nullptr };
- static DocUtilities &m_utilities;
-};
-Q_DECLARE_TYPEINFO(Doc, Q_RELOCATABLE_TYPE);
-typedef QList<Doc> DocList;
-
-QT_END_NAMESPACE
-
-#endif