CodeParser Class Reference

#include <codeparser.h>

Inheritance diagram for CodeParser:

Collaboration diagram for CodeParser:

Public Member Functions
	CodeParser ()
	The constructor adds this code parser to the static list of code parsers.
virtual	~CodeParser ()
	The destructor removes this code parser from the static list of code parsers.
virtual void	initializeParser ()=0
virtual void	terminateParser ()
	Terminating a code parser is trivial.
virtual QString	language ()=0
virtual QStringList	sourceFileNameFilter ()=0
virtual void	parseSourceFile (const Location &location, const QString &filePath, CppCodeParser &cpp_code_parser)=0

Static Public Member Functions
static void	initialize ()
	All the code parsers in the static list are initialized here, after the qdoc configuration variables have been set.
static void	terminate ()
	All the code parsers in the static list are terminated here.
static CodeParser *	parserForLanguage (const QString &language)
static CodeParser *	parserForSourceFile (const QString &filePath)
static void	setLink (Node *node, Node::LinkType linkType, const QString &arg)
static bool	isWorthWarningAbout (const Doc &doc)
	Test for whether a doc comment warrants warnings.

Static Public Attributes
static const QSet< QString >	common_meta_commands

Static Protected Member Functions
static void	extractPageLinkAndDesc (QStringView arg, QString *link, QString *desc)

Protected Attributes
QDocDatabase *	m_qdb {}

Detailed Description

Definition at line 105 of file codeparser.h.

Constructor & Destructor Documentation

CodeParser()

CodeParser::CodeParser

(

)

The constructor adds this code parser to the static list of code parsers.

Definition at line 21 of file codeparser.cpp.

References m_qdb, and QDocDatabase::qdocDB().

Here is the call graph for this function:

~CodeParser()

CodeParser::~CodeParser ( )

virtual

The destructor removes this code parser from the static list of code parsers.

Definition at line 31 of file codeparser.cpp.

Member Function Documentation

extractPageLinkAndDesc()

void CodeParser::extractPageLinkAndDesc ( QStringView arg, QString * link, QString * desc )

staticprotected

Definition at line 90 of file codeparser.cpp.

initialize()

void CodeParser::initialize ( )

static

All the code parsers in the static list are initialized here, after the qdoc configuration variables have been set.

Definition at line 48 of file codeparser.cpp.

Referenced by processQdocconfFile().

Here is the caller graph for this function:

initializeParser()

virtual void CodeParser::initializeParser ( )

pure virtual

Implemented in QmlCodeParser.

isWorthWarningAbout()

bool CodeParser::isWorthWarningAbout ( const Doc & doc )

static

Test for whether a doc comment warrants warnings.

Returns true if qdoc should report that it has found something wrong with the qdoc comment in doc. Sometimes, qdoc should not report the warning, for example, when the comment contains the internal command, which normally means qdoc will not use the comment in the documentation anyway, so there is no point in reporting warnings about it.

Definition at line 133 of file codeparser.cpp.

Referenced by ClangCodeParser::parse_cpp_file(), CppCodeParser::processMetaCommand(), and CppCodeParser::processTopicCommand().

Here is the caller graph for this function:

language()

virtual QString CodeParser::language ( )

pure virtual

Implemented in QmlCodeParser.

parserForLanguage()

CodeParser * CodeParser::parserForLanguage ( const QString & language )

static

Definition at line 63 of file codeparser.cpp.

parserForSourceFile()

CodeParser * CodeParser::parserForSourceFile ( const QString & filePath )

static

Definition at line 72 of file codeparser.cpp.

Referenced by parseSourceFiles().

Here is the caller graph for this function:

parseSourceFile()

virtual void CodeParser::parseSourceFile ( const Location & location, const QString & filePath, CppCodeParser & cpp_code_parser )

pure virtual

Implemented in QmlCodeParser.

setLink()

void CodeParser::setLink ( Node * node, Node::LinkType linkType, const QString & arg )

static

Definition at line 115 of file codeparser.cpp.

sourceFileNameFilter()

virtual QStringList CodeParser::sourceFileNameFilter ( )

pure virtual

Implemented in QmlCodeParser.

terminate()

void CodeParser::terminate ( )

static

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

Definition at line 57 of file codeparser.cpp.

Referenced by processQdocconfFile().

Here is the caller graph for this function:

terminateParser()

void CodeParser::terminateParser ( )

virtual

Terminating a code parser is trivial.

Reimplemented in QmlCodeParser.

Definition at line 39 of file codeparser.cpp.

Member Data Documentation

common_meta_commands

const QSet<QString> CodeParser::common_meta_commands

inlinestatic

Initial value:

{
        COMMAND_ABSTRACT, COMMAND_CMAKEPACKAGE, COMMAND_CMAKECOMPONENT, COMMAND_CMAKETARGETITEM, COMMAND_DEFAULT,
        COMMAND_DEPRECATED, COMMAND_INGROUP, COMMAND_INMODULE, COMMAND_INPUBLICGROUP, COMMAND_INQMLMODULE,
        COMMAND_INTERNAL, COMMAND_MODULESTATE, COMMAND_NOAUTOLIST, COMMAND_NONREENTRANT, COMMAND_OBSOLETE,
        COMMAND_PRELIMINARY, COMMAND_QMLABSTRACT, COMMAND_QMLDEFAULT, COMMAND_QMLENUMERATORSFROM, COMMAND_QMLINHERITS,
        COMMAND_QMLREADONLY, COMMAND_QMLREQUIRED, COMMAND_QTCMAKEPACKAGE, COMMAND_QTCMAKETARGETITEM,
        COMMAND_QTVARIABLE, COMMAND_REENTRANT, COMMAND_SINCE, COMMAND_STARTPAGE, COMMAND_SUBTITLE,
        COMMAND_THREADSAFE, COMMAND_TITLE, COMMAND_WRAPPER, COMMAND_ATTRIBUTION,
    }

Definition at line 108 of file codeparser.h.

m_qdb

QDocDatabase* CodeParser::m_qdb {}

protected

Definition at line 137 of file codeparser.h.

Referenced by CodeParser().

---

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

• qttools/src/qdoc/qdoc/src/qdoc/codeparser.h (77a13c15833f21a09ed4a367835ccaf1f1d07627)
• qttools/src/qdoc/qdoc/src/qdoc/codeparser.cpp (5212645b4665917019a96ba873d9e98c1a136b5f)