diff options
author | Martin Smith <martin.smith@qt.io> | 2019-01-14 14:42:23 +0100 |
---|---|---|
committer | Martin Smith <martin.smith@qt.io> | 2019-02-08 08:46:37 +0000 |
commit | 438e477d35c4e62251664878bdbf9f8efc85cd0d (patch) | |
tree | bebb6979e234c6f22b7ba59d4e55e5d6f5c63bee /src/qdoc/tree.h | |
parent | 1e8fc9db36a002a5ff5bdf9f9271de13478ef4a2 (diff) |
qdoc: Correct ref pages for inner classes
This update corrects the documentation pages for classes,
structs, and unions that are declared inside a class or a
struct. In Qt, a struct is often declared inside a class.
For such internal declarations, the requirements for
making the inner entity available were incorrectly shown.
All that is really necessary is to include the parent class.
So the requirements for including the inner entity are now
replaced with, for example, "Struct State is declared in
class QAccessible," where QAccessible becomes a link to the
reference page for that class.
It was easier to implement this change by teaching qdoc to
recognize structs and unions in addition to classes, so that
is also included in this change.
Change-Id: I1a0d46ef19a130506c7bcbf77b46e298f6ab2f71
Task-number: QTBUG-66872
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/qdoc/tree.h')
-rw-r--r-- | src/qdoc/tree.h | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/src/qdoc/tree.h b/src/qdoc/tree.h index 86637bf3e..abef4cca1 100644 --- a/src/qdoc/tree.h +++ b/src/qdoc/tree.h @@ -123,12 +123,13 @@ class Tree Node* findNodeRecursive(const QStringList& path, int pathIndex, const Node* start, - Node::NodeType type) const; + bool (Node::*) () const) const; +#if 0 Node* findNodeRecursive(const QStringList& path, int pathIndex, - Node* start, - const QList<int> &types) const; - + const Node* start, + Node::NodeType type) const; +#endif const Node* findNodeForTarget(const QStringList& path, const QString& target, const Node* node, @@ -150,8 +151,8 @@ class Tree QmlTypeNode* findQmlTypeNode(const QStringList& path); - Node* findNodeByNameAndType(const QStringList& path, Node::NodeType type) const; - Aggregate *findRelatesNode(const QStringList &path); + Node* findNodeByNameAndType(const QStringList& path, bool (Node::*isMatch) () const) const; + Aggregate* findRelatesNode(const QStringList& path); QString getRef(const QString& target, const Node* node) const; void insertTarget(const QString& name, const QString& title, |