IR Namespace Reference

Classes
class	Builder
	Assembles IR Documents from pre-extracted metadata. More...
struct	QmlTypeData
struct	CollectionData
struct	PageMetadata
struct	InlineContent
	Represents inline content within a documentation block. More...
struct	ContentBlock
	Represents a structural block element in documentation. More...
class	ContentBuilder
	Converts Atom chains to QList<IR::ContentBlock> trees. More...
struct	QmlTypeInfo
struct	CollectionInfo
struct	Document
	Intermediate representation for a documentation topic. More...
struct	Link
	Intermediate representation for a resolved hyperlink. More...
struct	ParameterIR
	Intermediate representation of a function parameter. More...
struct	EnumValueIR
	Intermediate representation of a single enum value. More...
struct	MemberIR
	Intermediate representation of a single documentable member. More...
struct	InheritedMembersIR
	Summary of members inherited from a single base class. More...
struct	SectionIR
	Intermediate representation of a member summary section. More...
struct	AllMemberEntry
	A single entry in an all-members listing page. More...
struct	MemberGroup
	Members grouped by originating QML type in an all-members listing. More...
struct	AllMembersIR
	Intermediate representation of the all-members listing page. More...
struct	AtomContext

Typedefs
using	DiagnosticHandler = std::function<void(QtMsgType, const QString &)>

Enumerations
enum class	InlineType : unsigned char {   Text , Code , Link , Bold ,   Italic , Teletype , Underline , Strikethrough ,   Subscript , Superscript , Parameter , LineBreak ,   Image , Keyword , Target }
enum class	LinkOrigin : unsigned char { Auto , Explicit }
enum class	LinkState : unsigned char {   Unresolved , Resolved , External , Broken ,   Suppressed , Ignored }
enum class	BlockType : unsigned char {   Paragraph , CodeBlock , List , ListItem ,   Section , SectionHeading , Note , Warning ,   Important , Details , Brief , Div ,   Quotation , Legalese , HorizontalRule , Table ,   TableRow , TableHeaderRow , TableCell , Raw ,   DefinitionList , DefinitionTerm , DefinitionDescription }
enum class	BriefHandling { Skip , Include }

Functions
static QString	inlineTypeId (InlineType type)
static QString	blockTypeId (BlockType type)
static InlineType	formattingToInlineType (const QString &formatting)
static QJsonArray	memberEntriesToJson (const QList< CollectionInfo::MemberEntry > &entries)
QJsonObject	classificationObject (const QString &id, const QString &label)
std::optional< QJsonObject >	nodeTypeToJson (NodeType t)
std::optional< QJsonObject >	genusToJson (Genus g)
QJsonObject	statusToJson (Status s)
QJsonObject	accessToJson (Access a)

Typedef Documentation

DiagnosticHandler

using IR::DiagnosticHandler = std::function<void(QtMsgType, const QString &)>

Definition at line 21 of file contentbuilder.h.

Enumeration Type Documentation

BlockType

enum class IR::BlockType : unsigned char

strong

Enumerator
Paragraph
CodeBlock
List
ListItem
Section
SectionHeading
Note
Warning
Important
Details
Brief
Div
Quotation
Legalese
HorizontalRule
Table
TableRow
TableHeaderRow
TableCell
Raw
DefinitionList
DefinitionTerm
DefinitionDescription

Definition at line 68 of file contentblock.h.

BriefHandling

enum class IR::BriefHandling

strong

Enumerator
Skip
Include

Definition at line 37 of file contentbuilder.h.

InlineType

enum class IR::InlineType : unsigned char

strong

Enumerator
Text
Code
Link
Bold
Italic
Teletype
Underline
Strikethrough
Subscript
Superscript
Parameter
LineBreak
Image
Keyword
Target

Definition at line 17 of file contentblock.h.

LinkOrigin

enum class IR::LinkOrigin : unsigned char

strong

Enumerator
Auto
Explicit

Definition at line 35 of file contentblock.h.

LinkState

enum class IR::LinkState : unsigned char

strong

Enumerator
Unresolved
Resolved
External
Broken
Suppressed
Ignored

Definition at line 40 of file contentblock.h.

Function Documentation

accessToJson()

QJsonObject IR::accessToJson ( Access a )

inline

Definition at line 128 of file classificationjson.h.

blockTypeId()

QString IR::blockTypeId ( BlockType type )

static

Definition at line 149 of file contentblock.cpp.

classificationObject()

QJsonObject IR::classificationObject ( const QString & id, const QString & label )

inline

Definition at line 25 of file classificationjson.h.

formattingToInlineType()

InlineType IR::formattingToInlineType ( const QString & formatting )

static

Definition at line 116 of file contentbuilder.cpp.

References Bold, Italic, Parameter, Subscript, Superscript, Teletype, Text, and Underline.

genusToJson()

std::optional< QJsonObject > IR::genusToJson ( Genus g )

inline

Definition at line 92 of file classificationjson.h.

inlineTypeId()

QString IR::inlineTypeId ( InlineType type )

static

Definition at line 126 of file contentblock.cpp.

memberEntriesToJson()

QJsonArray IR::memberEntriesToJson ( const QList< CollectionInfo::MemberEntry > & entries )

static

Definition at line 76 of file document.cpp.

nodeTypeToJson()

std::optional< QJsonObject > IR::nodeTypeToJson ( NodeType t )

inline

Definition at line 34 of file classificationjson.h.

References NoType.

statusToJson()

QJsonObject IR::statusToJson ( Status s )

inline

Definition at line 110 of file classificationjson.h.