FnCommandParser Struct Reference

#include <clangcodeparser.h>

Collaboration diagram for FnCommandParser:

Public Member Functions
	FnCommandParser (QDocDatabase *qdb, const std::set< Config::HeaderFilePath > &all_headers, const QList< QByteArray > &defines, std::optional< std::reference_wrapper< const PCHFile > > pch)
std::variant< Node *, FnMatchError >	operator() (const Location &location, const QString &fnSignature, const QString &idTag, QStringList context)
	Use clang to parse the function signature from a function command.

Detailed Description

Definition at line 40 of file clangcodeparser.h.

Constructor & Destructor Documentation

FnCommandParser()

FnCommandParser::FnCommandParser ( QDocDatabase * qdb, const std::set< Config::HeaderFilePath > & all_headers, const QList< QByteArray > & defines, std::optional< std::reference_wrapper< const PCHFile > > pch )

inline

Definition at line 41 of file clangcodeparser.h.

Member Function Documentation

operator()()

std::variant< Node *, FnMatchError > FnCommandParser::operator()	(	const Location &	location,
		const QString &	fnSignature,
		const QString &	idTag,
		QStringList	context )

Use clang to parse the function signature from a function command.

location is used for reporting errors. fnSignature is the string to parse. It is always a function decl. idTag is the optional bracketed argument passed to \fn, or an empty string. context is a string list representing the scope (namespaces) under which the function is declared.

Returns a variant that's either a Node instance tied to the function declaration, or a parsing failure for later processing.

Definition at line 1816 of file clangcodeparser.cpp.

References Parameters::count(), fnDummyFileName, kClangDontDisplayDiagnostics, Parameters::operator[](), FunctionNode::parameters(), printDiagnostics(), and ClangVisitor::visitFnArg().

Here is the call graph for this function:

---

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

• qttools/src/qdoc/qdoc/src/qdoc/clangcodeparser.h (540ae68c6e2784a0825c39c9d28eb4d8dac2c53a)
• qttools/src/qdoc/qdoc/src/qdoc/clangcodeparser.cpp (4a368a06afa5929d8674d2e94c2d7cbd6ad85d4e)