#include <codemarker.h>

Inheritance diagram for CodeMarker:

Collaboration diagram for CodeMarker:

Public Member Functions
	CodeMarker ()
	When a code marker constructs itself, it puts itself into the static list of code markers.
virtual	~CodeMarker ()
	When a code marker destroys itself, it removes itself from the static list of code markers.
virtual void	initializeMarker ()
	A code market performs no initialization by default.
virtual void	terminateMarker ()
	Terminating a code marker is trivial.
virtual bool	recognizeCode (const QString &)
virtual bool	recognizeExtension (const QString &)
virtual bool	recognizeFileName (const QString &name)
virtual bool	recognizeLanguage (const QString &language)
virtual Atom::AtomType	atomType () const
virtual QString	markedUpCode (const QString &code, const Node *, const Location &)
virtual QString	markedUpSynopsis (const Node , const Node , Section::Style)
virtual QString	markedUpQmlItem (const Node *, bool)
virtual QString	markedUpName (const Node *)
virtual QString	markedUpEnumValue (const QString &, const Node *)

Static Public Member Functions
static void	initialize ()
	All the code markers in the static list are initialized here, after the qdoc configuration file has been loaded.
static void	terminate ()
	All the code markers in the static list are terminated here.
static CodeMarker *	markerForCode (const QString &code)
static CodeMarker *	markerForFileName (const QString &fileName)
	Returns the appropriate code marker for the content in the file with the given fileName, which is typically the whole file path.
static CodeMarker *	markerForLanguage (const QString &lang)
static QString	extraSynopsis (const Node *node, Section::Style style)
	Returns the 'extra' synopsis string for node with status information, using a specified section style.
static QString	typified (const QString &string, bool trailingSpace=false)

Protected Member Functions
QString	taggedNode (const Node *node)
QString	taggedQmlNode (const Node *node)
QString	linkTag (const Node *node, const QString &body)

Static Protected Member Functions
static QString	protect (const QString &string)
static void	appendProtectedString (QString *output, QStringView str)

Detailed Description

Definition at line 12 of file codemarker.h.

Constructor & Destructor Documentation

◆ CodeMarker()

CodeMarker::CodeMarker ( )

When a code marker constructs itself, it puts itself into the static list of code markers.

All the code markers in the static list get initialized in initialize(), which is not called until after the qdoc configuration file has been read.

Definition at line 34 of file codemarker.cpp.

◆ ~CodeMarker()

CodeMarker::~CodeMarker ( )

virtual

When a code marker destroys itself, it removes itself from the static list of code markers.

Definition at line 43 of file codemarker.cpp.

Member Function Documentation

◆ appendProtectedString()

void CodeMarker::appendProtectedString	(	QString *	output,
		QStringView	str )

staticprotected

Definition at line 298 of file codemarker.cpp.

◆ atomType()

virtual Atom::AtomType CodeMarker::atomType ( ) const

inlinenodiscardvirtual

Reimplemented in CppCodeMarker, and QmlCodeMarker.

Definition at line 24 of file codemarker.h.

References Atom::Code.

Referenced by DocBookGenerator::generateExampleFilePage(), HtmlGenerator::generateExampleFilePage(), and DocParser::parse().

Here is the caller graph for this function:

◆ extraSynopsis()

QString CodeMarker::extraSynopsis	(	const Node *	node,
		Section::Style	style )

static

Returns the 'extra' synopsis string for node with status information, using a specified section style.

Definition at line 187 of file codemarker.cpp.

References PropertyNode::BindableProperty, Class, Section::Details, Enum, Function, Node< _Tp >::nodeType(), Property, QmlProperty, Struct, Section::Summary, TypeAlias, and Union.

Here is the call graph for this function:

◆ initialize()

void CodeMarker::initialize ( )

static

All the code markers in the static list are initialized here, after the qdoc configuration file has been loaded.

Definition at line 66 of file codemarker.cpp.

Referenced by processQdocconfFile().

Here is the caller graph for this function:

◆ initializeMarker()

void CodeMarker::initializeMarker ( )

virtual

A code market performs no initialization by default.

Marker-specific initialization is performed in subclasses.

Definition at line 52 of file codemarker.cpp.

◆ linkTag()

QString CodeMarker::linkTag	(	const Node *	node,
		const QString &	body )

protected

Definition at line 441 of file codemarker.cpp.

◆ markedUpCode()

virtual QString CodeMarker::markedUpCode	(	const QString &	code,
		const Node *	,
		const Location &	)

inlinevirtual

Reimplemented in CppCodeMarker, and QmlCodeMarker.

Definition at line 25 of file codemarker.h.

◆ markedUpEnumValue()

virtual QString CodeMarker::markedUpEnumValue	(	const QString &	,
		const Node *	)

inlinevirtual

Reimplemented in CppCodeMarker.

Definition at line 37 of file codemarker.h.

◆ markedUpName()

virtual QString CodeMarker::markedUpName ( const Node * )

inlinevirtual

Reimplemented in CppCodeMarker, and QmlCodeMarker.

Definition at line 36 of file codemarker.h.

◆ markedUpQmlItem()

virtual QString CodeMarker::markedUpQmlItem	(	const Node *	,
		bool	)

inlinevirtual

Reimplemented in CppCodeMarker.

Definition at line 35 of file codemarker.h.

◆ markedUpSynopsis()

virtual QString CodeMarker::markedUpSynopsis	(	const Node *	,
		const Node *	,
		Section::Style	)

inlinevirtual

Reimplemented in CppCodeMarker.

Definition at line 30 of file codemarker.h.

◆ markerForCode()

CodeMarker * CodeMarker::markerForCode ( const QString & code )

static

Definition at line 82 of file codemarker.cpp.

◆ markerForFileName()

CodeMarker * CodeMarker::markerForFileName ( const QString & fileName )

static

Returns the appropriate code marker for the content in the file with the given fileName, which is typically the whole file path.

This is achieved by first checking the file extension, then checking the file name.

Definition at line 102 of file codemarker.cpp.

◆ markerForLanguage()

CodeMarker * CodeMarker::markerForLanguage ( const QString & lang )

static

Definition at line 125 of file codemarker.cpp.

◆ protect()

QString CodeMarker::protect ( const QString & string )

staticprotected

Definition at line 293 of file codemarker.cpp.

◆ recognizeCode()

virtual bool CodeMarker::recognizeCode ( const QString & )

inlinevirtual

Reimplemented in CppCodeMarker, and QmlCodeMarker.

Definition at line 20 of file codemarker.h.

◆ recognizeExtension()

virtual bool CodeMarker::recognizeExtension ( const QString & )

inlinevirtual

Reimplemented in CppCodeMarker, and QmlCodeMarker.

Definition at line 21 of file codemarker.h.

◆ recognizeFileName()

bool CodeMarker::recognizeFileName ( const QString & name )

virtual

Reimplemented in CppCodeMarker, and QmlCodeMarker.

Definition at line 134 of file codemarker.cpp.

◆ recognizeLanguage()

bool CodeMarker::recognizeLanguage ( const QString & language )

virtual

Reimplemented in CppCodeMarker, and QmlCodeMarker.

Definition at line 139 of file codemarker.cpp.

◆ taggedNode()

QString CodeMarker::taggedNode ( const Node * node )

protected

Definition at line 372 of file codemarker.cpp.

References Class, Enum, Function, Namespace, Node< _Tp >::nodeType(), Page, Property, QmlType, Struct, TypeAlias, Typedef, and Union.

Here is the call graph for this function:

◆ taggedQmlNode()

QString CodeMarker::taggedQmlNode ( const Node * node )

protected

Definition at line 413 of file codemarker.cpp.

References Node< _Tp >::isFunction(), Node< _Tp >::isQmlProperty(), QmlMethod, QmlSignal, and QmlSignalHandler.

Here is the call graph for this function:

◆ terminate()

void CodeMarker::terminate ( )

static

All the code markers in the static list are terminated here.

Definition at line 76 of file codemarker.cpp.

Referenced by processQdocconfFile().

Here is the caller graph for this function:

◆ terminateMarker()

void CodeMarker::terminateMarker ( )

virtual

Terminating a code marker is trivial.

Definition at line 57 of file codemarker.cpp.

◆ typified()

QString CodeMarker::typified	(	const QString &	string,
		bool	trailingSpace = false )

static

Definition at line 323 of file codemarker.cpp.

The documentation for this class was generated from the following files:

qttools/src/qdoc/qdoc/src/qdoc/codemarker.h (4e7af294df5f0a93096d8db720b6a308901032c3)
qttools/src/qdoc/qdoc/src/qdoc/codemarker.cpp (e1f5ccaa66546ed708f6c4e23346195094231e8d)

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CodeMarker()

◆ ~CodeMarker()

Member Function Documentation

◆ appendProtectedString()

◆ atomType()

◆ extraSynopsis()

◆ initialize()

◆ initializeMarker()

◆ linkTag()

◆ markedUpCode()

◆ markedUpEnumValue()

◆ markedUpName()

◆ markedUpQmlItem()

◆ markedUpSynopsis()

◆ markerForCode()

◆ markerForFileName()

◆ markerForLanguage()

◆ protect()

◆ recognizeCode()

◆ recognizeExtension()

◆ recognizeFileName()

◆ recognizeLanguage()

◆ taggedNode()

◆ taggedQmlNode()

◆ terminate()

◆ terminateMarker()

◆ typified()