 |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
|
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
A class representing a forest of Tree objects. More...
#include <qdocdatabase.h>
Collaboration diagram for QDocForest:Friends | |
| class | QDocDatabase |
A class representing a forest of Tree objects.
This private class manages a collection of Tree objects (a forest) for the singleton QDocDatabase object. It is only accessed by that singleton QDocDatabase object, which is a friend. Each tree in the forest is an instance of class Tree, which is a mostly private class. Both QDocForest and QDocDatabase are friends of Tree and have full access.
There are two kinds of trees in the forest, differing not in structure but in use. One Tree is the primary tree. It is the tree representing the module being documented. All the other trees in the forest are called index trees. Each one represents the contents of the index file for one of the modules the current module must be able to link to.
The instances of subclasses of Node in the primary tree will contain documentation in an instance of Doc. The index trees contain no documentation, and each Node in an index tree is marked as an index node.
Each tree is named with the name of its module.
The search order is created by searchOrder(), if it has not already been created. The search order and module names arrays have parallel structure, i.e. modulNames_[i] is the module name of the Tree at searchOrder_[i].
The primary tree is always the first tree in the search order. i.e., when the database is searched, the primary tree is always searched first, unless a specific tree is being searched.
Definition at line 33 of file qdocdatabase.h.
|
friend |
Definition at line 36 of file qdocdatabase.h.
1.12.0