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
irbuilder.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 IRBUILDER_H
5#define IRBUILDER_H
6
7#include "documentir.h"
8
10
11class PageNode;
12
14{
15public:
16 IRBuilder() = default;
17
18 [[nodiscard]] DocumentIR buildPageIR(const PageNode *pn) const;
19};
20
21QT_END_NAMESPACE
22
23#endif // IRBUILDER_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 irbuilder.h:14
IRBuilder()=default
DocumentIR buildPageIR(const PageNode *pn) const
Definition irbuilder.cpp:64
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
Combined button and popup list for selecting options.
Intermediate representation for a documentation topic.
Definition documentir.h:20
const Doc & doc() const
Returns a reference to the node's Doc data member.
Definition node.h:235