blob: 37375996853c45f4d6e23e4c62fcc5d949ec4372 (
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
|
/****************************************************************************
**
** 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 NAMESPACENODE_H
#define NAMESPACENODE_H
#include "aggregate.h"
#include <QtCore/qglobal.h>
#include <QtCore/qstring.h>
QT_BEGIN_NAMESPACE
class Tree;
class NamespaceNode : public Aggregate
{
public:
NamespaceNode(Aggregate *parent, const QString &name) : Aggregate(Namespace, parent, name) {}
~NamespaceNode() override;
[[nodiscard]] Tree *tree() const override { return (parent() ? parent()->tree() : m_tree); }
[[nodiscard]] bool isFirstClassAggregate() const override { return true; }
[[nodiscard]] bool isRelatableType() const override { return true; }
[[nodiscard]] bool wasSeen() const override { return m_seen; }
void markSeen() { m_seen = true; }
void setTree(Tree *t) { m_tree = t; }
[[nodiscard]] const NodeList &includedChildren() const;
void includeChild(Node *child);
void setWhereDocumented(const QString &t) { m_whereDocumented = t; }
[[nodiscard]] bool isDocumentedHere() const;
[[nodiscard]] bool hasDocumentedChildren() const;
void reportDocumentedChildrenInUndocumentedNamespace() const;
[[nodiscard]] bool docMustBeGenerated() const override;
void setDocNode(NamespaceNode *ns) { m_docNode = ns; }
[[nodiscard]] NamespaceNode *docNode() const { return m_docNode; }
private:
bool m_seen { false };
Tree *m_tree { nullptr };
QString m_whereDocumented {};
NamespaceNode *m_docNode { nullptr };
NodeList m_includedChildren {};
};
QT_END_NAMESPACE
#endif // NAMESPACENODE_H
|