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
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
CodeMarker Class Reference

#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 recognizeLanguage (const QString &)
 
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 *)
 
QString typified (const QString &string, bool trailingSpace=false)
 

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)
 
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

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 30 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 39 of file codemarker.cpp.

Member Function Documentation

◆ appendProtectedString()

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

Definition at line 303 of file codemarker.cpp.

◆ atomType()

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

Reimplemented in CppCodeMarker, and QmlCodeMarker.

Definition at line 23 of file codemarker.h.

References Atom::Code.

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

+ 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 175 of file codemarker.cpp.

References Node< _Tp >::access(), PropertyNode::BindableProperty, Section::Details, Node< _Tp >::Enum, Node< _Tp >::Function, EnumNode::isAnonymous(), FunctionNode::isConstexpr(), FunctionNode::isDefault(), QmlPropertyNode::isDefault(), FunctionNode::isExplicit(), FunctionNode::isFinal(), FunctionNode::isInvokable(), FunctionNode::isNonvirtual(), FunctionNode::isOverride(), Parameters::isPrivateSignal(), FunctionNode::isPureVirtual(), QmlPropertyNode::isReadOnly(), QmlPropertyNode::isRequired(), FunctionNode::isSignal(), FunctionNode::isSlot(), FunctionNode::isStatic(), PropertyNode::isWritable(), Node< _Tp >::nodeType(), FunctionNode::parameters(), Node< _Tp >::Property, PropertyNode::propertyType(), Node< _Tp >::QmlProperty, Section::Summary, and Node< _Tp >::TypeAlias.

+ 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 62 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 48 of file codemarker.cpp.

◆ linkTag()

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

Definition at line 446 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 24 of file codemarker.h.

◆ markedUpEnumValue()

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

Reimplemented in CppCodeMarker.

Definition at line 36 of file codemarker.h.

◆ markedUpName()

virtual QString CodeMarker::markedUpName ( const Node * )
inlinevirtual

Reimplemented in CppCodeMarker, and QmlCodeMarker.

Definition at line 35 of file codemarker.h.

◆ markedUpQmlItem()

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

Reimplemented in CppCodeMarker.

Definition at line 34 of file codemarker.h.

◆ markedUpSynopsis()

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

Reimplemented in CppCodeMarker.

Definition at line 29 of file codemarker.h.

◆ markerForCode()

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

Definition at line 78 of file codemarker.cpp.

◆ markerForFileName()

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

Definition at line 92 of file codemarker.cpp.

◆ markerForLanguage()

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

Definition at line 109 of file codemarker.cpp.

◆ nodeForString()

const Node * CodeMarker::nodeForString ( const QString & string)
static

Definition at line 118 of file codemarker.cpp.

◆ protect()

QString CodeMarker::protect ( const QString & string)
staticprotected

Definition at line 276 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.

◆ recognizeLanguage()

virtual bool CodeMarker::recognizeLanguage ( const QString & )
inlinevirtual

Reimplemented in CppCodeMarker, and QmlCodeMarker.

Definition at line 22 of file codemarker.h.

◆ stringForNode()

QString CodeMarker::stringForNode ( const Node * node)
static

Definition at line 128 of file codemarker.cpp.

◆ taggedNode()

QString CodeMarker::taggedNode ( const Node * node)
protected

Definition at line 377 of file codemarker.cpp.

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

+ Here is the call graph for this function:

◆ taggedQmlNode()

QString CodeMarker::taggedQmlNode ( const Node * node)
protected

Definition at line 418 of file codemarker.cpp.

References Node< _Tp >::isFunction(), Node< _Tp >::isQmlProperty(), FunctionNode::metaness(), FunctionNode::QmlMethod, FunctionNode::QmlSignal, and FunctionNode::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 72 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 53 of file codemarker.cpp.

◆ typified()

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

Definition at line 328 of file codemarker.cpp.

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