QmlCodeMarker Class Reference

#include <qmlcodemarker.h>

Inheritance diagram for QmlCodeMarker:

Collaboration diagram for QmlCodeMarker:

Public Member Functions
	QmlCodeMarker ()=default
	~QmlCodeMarker () override=default
bool	recognizeCode (const QString &code) override
	Returns true if the code is recognized by the parser.
bool	recognizeExtension (const QString &ext) override
	Returns true if ext is any of a list of file extensions for the QML language.
bool	recognizeLanguage (const QString &language) override
	Returns true if the language is recognized.
Atom::AtomType	atomType () const override
	Returns the type of atom used to represent QML code in the documentation.
QString	markedUpCode (const QString &code, const Node *relative, const Location &location) override
QString	markedUpName (const Node *node) override
	Constructs and returns the marked up name for the node.
QList< QQmlJS::SourceLocation >	extractPragmas (QString &script)
Public Member Functions inherited from CppCodeMarker
	CppCodeMarker ()=default
	~CppCodeMarker () override=default
QString	markedUpSynopsis (const Node *node, const Node *relative, Section::Style style) override
QString	markedUpQmlItem (const Node *node, bool summary) override
QString	markedUpEnumValue (const QString &enumValue, const Node *relative) override
Public Member Functions inherited from CodeMarker
	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.
QString	typified (const QString &string, bool trailingSpace=false)

Additional Inherited Members
Static Public Member Functions inherited from CodeMarker
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)
static CodeMarker *	markerForLanguage (const QString &lang)
static const Node *	nodeForString (const QString &string)
static QString	stringForNode (const Node *node)
static QString	extraSynopsis (const Node *node, Section::Style style)
	Returns the 'extra' synopsis string for node with status information, using a specified section style.
Protected Member Functions inherited from CodeMarker
QString	taggedNode (const Node *node)
QString	taggedQmlNode (const Node *node)
QString	linkTag (const Node *node, const QString &body)
Static Protected Member Functions inherited from CodeMarker
static QString	protect (const QString &string)
static void	appendProtectedString (QString *output, QStringView str)

Detailed Description

Definition at line 13 of file qmlcodemarker.h.

Constructor & Destructor Documentation

QmlCodeMarker()

QmlCodeMarker::QmlCodeMarker ( )

default

~QmlCodeMarker()

QmlCodeMarker::~QmlCodeMarker ( )

overridedefault

Member Function Documentation

atomType()

Atom::AtomType QmlCodeMarker::atomType ( ) const

nodiscardoverridevirtual

Returns the type of atom used to represent QML code in the documentation.

Reimplemented from CppCodeMarker.

Definition at line 63 of file qmlcodemarker.cpp.

References Atom::Qml.

extractPragmas()

QList< QQmlJS::SourceLocation > QmlCodeMarker::extractPragmas

(

QString &

script

)

Definition at line 137 of file qmlcodemarker.cpp.

markedUpCode()

QString QmlCodeMarker::markedUpCode ( const QString & code, const Node * relative, const Location & location )

overridevirtual

Reimplemented from CppCodeMarker.

Definition at line 68 of file qmlcodemarker.cpp.

markedUpName()

QString QmlCodeMarker::markedUpName ( const Node * node )

overridevirtual

Constructs and returns the marked up name for the node.

If the node is any kind of QML function (a method, signal, or handler), "()" is appended to the marked up name.

Reimplemented from CppCodeMarker.

Definition at line 79 of file qmlcodemarker.cpp.

References Node< _Tp >::isFunction().

Here is the call graph for this function:

recognizeCode()

QT_BEGIN_NAMESPACE bool QmlCodeMarker::recognizeCode ( const QString & code )

overridevirtual

Returns true if the code is recognized by the parser.

Reimplemented from CppCodeMarker.

Definition at line 24 of file qmlcodemarker.cpp.

recognizeExtension()

bool QmlCodeMarker::recognizeExtension ( const QString & ext )

overridevirtual

Returns true if ext is any of a list of file extensions for the QML language.

Reimplemented from CppCodeMarker.

Definition at line 46 of file qmlcodemarker.cpp.

recognizeLanguage()

bool QmlCodeMarker::recognizeLanguage ( const QString & language )

overridevirtual

Returns true if the language is recognized.

Only "QML" is recognized by this marker.

Reimplemented from CppCodeMarker.

Definition at line 55 of file qmlcodemarker.cpp.

---

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

• qttools/src/qdoc/qdoc/src/qdoc/qmlcodemarker.h (f6ca8112983926c0e0db44e03b9090d02bdf0048)
• qttools/src/qdoc/qdoc/src/qdoc/qmlcodemarker.cpp (f6ca8112983926c0e0db44e03b9090d02bdf0048)