IR Namespace Reference

Classes
class	Builder
	Assembles IR Documents from pre-extracted metadata. More...
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	Document
	Intermediate representation for a documentation topic. More...
struct	Link
	Intermediate representation for a resolved hyperlink. More...
struct	AtomContext

Enumerations
enum class	InlineType : unsigned char {   Text , Code , Link , Bold ,   Italic , Teletype , Underline , Strikethrough ,   Subscript , Superscript , Parameter , LineBreak ,   Image , Keyword , Target }
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 }

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

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

Definition at line 46 of file contentblock.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 15 of file contentblock.h.

Function Documentation

accessToJson()

QJsonObject IR::accessToJson ( Access a )

static

Definition at line 105 of file document.cpp.

blockTypeId()

QString IR::blockTypeId ( BlockType type )

static

Definition at line 148 of file contentblock.cpp.

classificationObject()

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

static

Definition at line 37 of file document.cpp.

formattingToInlineType()

InlineType IR::formattingToInlineType ( const QString & formatting )

static

Definition at line 71 of file contentbuilder.cpp.

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

genusToJson()

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

static

Definition at line 79 of file document.cpp.

inlineTypeId()

QString IR::inlineTypeId ( InlineType type )

static

Definition at line 125 of file contentblock.cpp.

nodeTypeToJson()

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

static

Definition at line 46 of file document.cpp.

References NoType.

statusToJson()

QJsonObject IR::statusToJson ( Status s )

static

Definition at line 92 of file document.cpp.