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
#
include
"pagemetadata.h"
9
10
QT_BEGIN_NAMESPACE
11
12
namespace
IR
{
13
14
class
Builder
15
{
16
public
:
17
Builder
() =
default
;
18
19
[[nodiscard]]
Document
buildPageIR
(
PageMetadata
pm)
const
;
20
};
21
22
}
// namespace IR
23
24
QT_END_NAMESPACE
25
26
#
endif
// QDOC_IR_BUILDER_H
IR::Builder
Assembles IR Documents from pre-extracted metadata.
Definition
builder.h:15
IR::Builder::Builder
Builder()=default
IR::Builder::buildPageIR
Document buildPageIR(PageMetadata pm) const
Definition
builder.cpp:196
IR
Definition
builder.cpp:14
IR::buildThreadSafetyAdmonition
static QList< ContentBlock > buildThreadSafetyAdmonition(const CppReferenceData::ThreadSafetyInfo &ts, const QString &typeWord)
Definition
builder.cpp:107
IR::makeResolvedLink
static InlineContent makeResolvedLink(const QString &name, const QString &href)
Definition
builder.cpp:74
IR::LinkState
LinkState
Definition
contentblock.h:41
IR::LinkState::Unresolved
@ Unresolved
Definition
contentblock.h:42
IR::LinkState::Resolved
@ Resolved
Definition
contentblock.h:43
IR::LinkOrigin
LinkOrigin
Definition
contentblock.h:35
IR::LinkOrigin::Synthesized
@ Synthesized
Definition
contentblock.h:38
IR::appendExceptionList
static void appendExceptionList(QList< InlineContent > &inlines, const QString &prefix, const QString &topicName, const QList< CppReferenceData::ThreadSafetyExceptionEntry > &exceptions)
Definition
builder.cpp:84
IR::BlockType
BlockType
Definition
contentblock.h:69
IR::BlockType::Paragraph
@ Paragraph
Definition
contentblock.h:70
IR::makeTopicLink
static InlineContent makeTopicLink(const QString &topicName)
Definition
builder.cpp:54
IR::makeTextInline
static InlineContent makeTextInline(const QString &text)
Definition
builder.cpp:35
IR::gatherBodyTocEntries
static void gatherBodyTocEntries(const QList< ContentBlock > &blocks, QList< NavigationInfo::TocEntry > &out)
Definition
builder.cpp:16
IR::InlineType
InlineType
Definition
contentblock.h:17
IR::InlineType::Link
@ Link
Definition
contentblock.h:20
IR::InlineType::Text
@ Text
Definition
contentblock.h:18
QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition
qrandomaccessasyncfile_darwin.mm:17
std
[33]
Definition
src_corelib_tools_qhash.cpp:421
IR::CollectionInfo
Definition
document.h:55
IR::CollectionInfo::isModule
bool isModule
Definition
document.h:64
IR::CollectionInfo::noAutoList
bool noAutoList
Definition
document.h:67
IR::CollectionInfo::isQmlModule
bool isQmlModule
Definition
document.h:65
IR::CollectionInfo::isGroup
bool isGroup
Definition
document.h:66
IR::ContentBlock
Represents a structural block element in documentation.
Definition
contentblock.h:98
IR::ContentBlock::type
BlockType type
Definition
contentblock.h:99
IR::CppReferenceData::ThreadSafetyInfo
Definition
pagemetadata.h:106
IR::CppReferenceData
Definition
pagemetadata.h:78
IR::CppReferenceInfo::QmlNativeTypeLink
Definition
document.h:95
IR::CppReferenceInfo::ThreadSafetyInfo
Definition
document.h:111
IR::CppReferenceInfo
Definition
document.h:83
IR::CppReferenceInfo::isHeader
bool isHeader
Definition
document.h:138
IR::CppReferenceInfo::isInnerClass
bool isInnerClass
Definition
document.h:136
IR::CppReferenceInfo::suppressInheritance
bool suppressInheritance
Definition
document.h:132
IR::CppReferenceInfo::isPartialNamespace
bool isPartialNamespace
Definition
document.h:140
IR::CppReferenceInfo::hasObsoleteMembers
bool hasObsoleteMembers
Definition
document.h:155
IR::CppReferenceInfo::isNamespace
bool isNamespace
Definition
document.h:137
IR::Document
Intermediate representation for a documentation topic.
Definition
document.h:197
IR::Document::access
Access access
Definition
document.h:202
IR::Document::status
Status status
Definition
document.h:201
IR::Document::nodeType
NodeType nodeType
Definition
document.h:199
IR::Document::genus
Genus genus
Definition
document.h:200
IR::InlineContent::LinkData
Definition
contentblock.h:59
IR::InlineContent
Represents inline content within a documentation block.
Definition
contentblock.h:51
IR::InlineContent::type
InlineType type
Definition
contentblock.h:52
IR::NavigationInfo::LinkEntry
Definition
document.h:175
IR::NavigationInfo
Definition
document.h:162
IR::NavigationInfo::tocDepth
int tocDepth
Definition
document.h:191
IR::PageMetadata
Definition
pagemetadata.h:186
IR::PageMetadata::status
Status status
Definition
pagemetadata.h:189
IR::PageMetadata::access
Access access
Definition
pagemetadata.h:190
IR::PageMetadata::genus
Genus genus
Definition
pagemetadata.h:188
IR::PageMetadata::nodeType
NodeType nodeType
Definition
pagemetadata.h:187
IR::QmlTypeInfo::InheritsInfo
Definition
document.h:32
IR::QmlTypeInfo::NativeTypeInfo
Definition
document.h:45
IR::QmlTypeInfo
Definition
document.h:27
IR::QmlTypeInfo::isSingleton
bool isSingleton
Definition
document.h:29
IR::QmlTypeInfo::isValueType
bool isValueType
Definition
document.h:30
qttools
src
qdoc
qdoc
src
qdoc
ir
builder.h
Generated on
for Qt by
1.16.1