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 | List of all members
CppCodeMarker Class Reference

#include <cppcodemarker.h>

+ Inheritance diagram for CppCodeMarker:
+ Collaboration diagram for CppCodeMarker:

Public Member Functions

 CppCodeMarker ()=default
 
 ~CppCodeMarker () override=default
 
bool recognizeCode (const QString &code) override
 Returns true.
 
bool recognizeExtension (const QString &ext) override
 Returns true if ext is any of a list of file extensions for the C++ language.
 
bool recognizeLanguage (const QString &lang) override
 Returns true if lang is either "C" or "Cpp".
 
Atom::AtomType atomType () const override
 Returns the type of atom used to represent C++ code in the documentation.
 
QString markedUpCode (const QString &code, const Node *relative, const Location &location) override
 
QString markedUpSynopsis (const Node *node, const Node *relative, Section::Style style) override
 
QString markedUpQmlItem (const Node *node, bool summary) override
 
QString markedUpName (const Node *node) 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 11 of file cppcodemarker.h.

Constructor & Destructor Documentation

◆ CppCodeMarker()

CppCodeMarker::CppCodeMarker ( )
default

◆ ~CppCodeMarker()

CppCodeMarker::~CppCodeMarker ( )
overridedefault

Member Function Documentation

◆ atomType()

Atom::AtomType CppCodeMarker::atomType ( ) const
nodiscardoverridevirtual

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

Reimplemented from CodeMarker.

Reimplemented in QmlCodeMarker.

Definition at line 55 of file cppcodemarker.cpp.

References Atom::Code.

◆ markedUpCode()

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

Reimplemented from CodeMarker.

Reimplemented in QmlCodeMarker.

Definition at line 60 of file cppcodemarker.cpp.

◆ markedUpEnumValue()

QString CppCodeMarker::markedUpEnumValue ( const QString & enumValue,
const Node * relative )
overridevirtual

Reimplemented from CodeMarker.

Definition at line 293 of file cppcodemarker.cpp.

References Node< _Tp >::isEnumType(), Node< _Tp >::isHeader(), Node< _Tp >::isQmlProperty(), EnumNode::isScoped(), and Node< _Tp >::parent().

+ Here is the call graph for this function:

◆ markedUpName()

QString CppCodeMarker::markedUpName ( const Node * node)
overridevirtual

Reimplemented from CodeMarker.

Reimplemented in QmlCodeMarker.

Definition at line 285 of file cppcodemarker.cpp.

References Node< _Tp >::isFunction(), and Node< _Tp >::isMacro().

+ Here is the call graph for this function:

◆ markedUpQmlItem()

QString CppCodeMarker::markedUpQmlItem ( const Node * node,
bool summary )
overridevirtual

Reimplemented from CodeMarker.

Definition at line 231 of file cppcodemarker.cpp.

References Parameters::count(), QmlPropertyNode::isAttached(), Parameters::isEmpty(), Node< _Tp >::isFunction(), Node< _Tp >::isQmlProperty(), FunctionNode::parameters(), and Node< _Tp >::QML.

+ Here is the call graph for this function:

◆ markedUpSynopsis()

QString CppCodeMarker::markedUpSynopsis ( const Node * node,
const Node * relative,
Section::Style style )
overridevirtual

Reimplemented from CodeMarker.

Definition at line 66 of file cppcodemarker.cpp.

References Section::Accessors, Section::AllMembers, TypedefNode::associatedEnum(), Node< _Tp >::Class, Parameters::count(), Section::Details, Node< _Tp >::Enum, Node< _Tp >::Function, FunctionNode::isConst(), Parameters::isEmpty(), FunctionNode::isFinal(), Node< _Tp >::isHeader(), FunctionNode::isMacroWithoutParams(), FunctionNode::isNonvirtual(), FunctionNode::isOverride(), Node< _Tp >::isProperty(), Node< _Tp >::isProxyNode(), FunctionNode::isPureVirtual(), Node< _Tp >::isQmlNode(), FunctionNode::isRef(), FunctionNode::isRefRef(), Node< _Tp >::isRelatedNonmember(), EnumNode::isScoped(), Node< _Tp >::Namespace, Node< _Tp >::nodeType(), FunctionNode::parameters(), Node< _Tp >::parent(), Node< _Tp >::Property, Node< _Tp >::QmlProperty, Node< _Tp >::Struct, Section::Summary, Node< _Tp >::TypeAlias, Node< _Tp >::Typedef, Node< _Tp >::Union, and Node< _Tp >::Variable.

+ Here is the call graph for this function:

◆ recognizeCode()

bool CppCodeMarker::recognizeCode ( const QString & code)
overridevirtual

Returns true.

Reimplemented from CodeMarker.

Reimplemented in QmlCodeMarker.

Definition at line 27 of file cppcodemarker.cpp.

◆ recognizeExtension()

bool CppCodeMarker::recognizeExtension ( const QString & ext)
overridevirtual

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

Reimplemented from CodeMarker.

Reimplemented in QmlCodeMarker.

Definition at line 36 of file cppcodemarker.cpp.

◆ recognizeLanguage()

bool CppCodeMarker::recognizeLanguage ( const QString & lang)
overridevirtual

Returns true if lang is either "C" or "Cpp".

Reimplemented from CodeMarker.

Reimplemented in QmlCodeMarker.

Definition at line 47 of file cppcodemarker.cpp.

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