Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
builder.h
Go to the documentation of this file.
1// Copyright (C) 2026 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
3
4#ifndef QDOC_IR_BUILDER_H
5#define QDOC_IR_BUILDER_H
6
7#include "document.h"
8
10
11class PageNode;
12
13namespace IR {
14
16{
17public:
18 Builder() = default;
19
20 [[nodiscard]] Document buildPageIR(const PageNode *pn) const;
21};
22
23} // namespace IR
24
25QT_END_NAMESPACE
26
27#endif // QDOC_IR_BUILDER_H
The Atom class is the fundamental unit for representing documents internally.
Definition atom.h:19
AtomType type() const
Return the type of this atom.
Definition atom.h:153
@ BriefRight
Definition atom.h:27
@ String
Definition atom.h:93
@ BriefLeft
Definition atom.h:26
@ C
Definition atom.h:28
@ AutoLink
Definition atom.h:23
const Atom * next() const
Return the next atom in the atom list.
Definition atom.h:150
Builds IR (Intermediate Representation) from QDoc's Node tree.
Definition builder.h:16
Document buildPageIR(const PageNode *pn) const
Definition builder.cpp:66
Builder()=default
A PageNode is a Node that generates a documentation page.
Definition pagenode.h:19
Definition text.h:12
const Atom * firstAtom() const
Definition text.h:34
Definition builder.cpp:14
Combined button and popup list for selecting options.
Intermediate representation for a documentation topic.
Definition document.h:19
Access access
Definition document.h:24
Status status
Definition document.h:23
NodeType nodeType
Definition document.h:21
Genus genus
Definition document.h:22
const Doc & doc() const
Returns a reference to the node's Doc data member.
Definition node.h:235
NodeType nodeType() const override
Returns this node's type.
Definition node.h:82
Genus genus() const override
Returns this node's Genus.
Definition node.h:85
virtual Status status() const
Returns the node's status value.
Definition node.h:239
Access access() const
Returns the node's Access setting, which can be Public, Protected, or Private.
Definition node.h:228