generator.cpp File Reference

(8cf94ee85137cf19a87fcb5e7ae30d84a3c85c78)

#include "generator.h"
#include "access.h"
#include "aggregate.h"
#include "classnode.h"
#include "codemarker.h"
#include "codeparser.h"
#include "collectionnode.h"
#include "comparisoncategory.h"
#include "config.h"
#include "doc.h"
#include "editdistance.h"
#include "enumnode.h"
#include "examplenode.h"
#include "functionnode.h"
#include "inclusionfilter.h"
#include "inclusionpolicy.h"
#include "inode.h"
#include "node.h"
#include "openedlist.h"
#include "outputdirectory.h"
#include "outputproducerregistry.h"
#include "propertynode.h"
#include "qdocdatabase.h"
#include "qmltypenode.h"
#include "qmlpropertynode.h"
#include "quoter.h"
#include "sharedcommentnode.h"
#include "tokenizer.h"
#include "typedefnode.h"
#include "utilities.h"
#include <QtCore/qdebug.h>
#include <QtCore/qdir.h>
#include <QtCore/qregularexpression.h>
#include "QtCore/qurl.h"
#include <string>
#include <utility>

Include dependency graph for generator.cpp:

Go to the source code of this file.

Macros
#define	SKIP_CHAR(c)
#define	SKIP_SPACE

Enumerations
enum class	ValidationContext { FunctionDoc , TemplateDoc , FunctionDoc , TemplateDoc }
	Selects warning message wording based on documentation context. More...
enum class	ValidationContext { FunctionDoc , TemplateDoc , FunctionDoc , TemplateDoc }

Functions
static QRegularExpression	tag ("</?@[^>]*>")
static QSet< QString >	inheritedTemplateParamNames (const Node *node)
	Returns the set of template parameter names inherited from the parent scope chain of node.
static void	warnAboutUnknownDocumentedParams (const Node *node, const QSet< QString > &documentedNames, const QSet< QString > &allowedNames, ValidationContext context)
	Warns about documented parameter names in node that don't exist in allowedNames.
static void	startNote (Text &text)

Variables
static QLatin1String	amp ("&")
static QLatin1String	gt (">")
static QLatin1String	lt ("<")
static QLatin1String	quot (""")

Macro Definition Documentation

SKIP_CHAR

#define SKIP_CHAR

(

c

)

Value:

if (i >= n || src[i] != c)                                                                     \
    return false;                                                                              \
++i;

SKIP_SPACE

#define SKIP_SPACE

Value:

while (i < n && src[i] == ' ')                                                                 \
    ++i;

Enumeration Type Documentation

ValidationContext [1/2]

enum class ValidationContext

strong

Selects warning message wording based on documentation context.

\value FunctionDoc Warns "No such parameter" (function docs may reference both function parameters and template parameters). \value TemplateDoc Warns "No such template parameter" (template class/alias docs reference only template parameters).

Enumerator
FunctionDoc
TemplateDoc
FunctionDoc
TemplateDoc

Definition at line 103 of file generator.cpp.

ValidationContext [2/2]

enum class ValidationContext

strong

Enumerator
FunctionDoc
TemplateDoc
FunctionDoc
TemplateDoc

Definition at line 103 of file generator.cpp.

Function Documentation

inheritedTemplateParamNames()

QSet< QString > inheritedTemplateParamNames ( const Node * node )

static

Returns the set of template parameter names inherited from the parent scope chain of node.

This includes template parameters from enclosing class templates, which are visible but not required to be documented in nested classes or member functions.

Definition at line 84 of file generator.cpp.

References Node< _Tp >::parent(), and Node< _Tp >::templateDecl().

Here is the call graph for this function:

startNote()

void startNote ( Text & text )

static

Definition at line 1698 of file generator.cpp.

References Atom::FormattingLeft, Atom::FormattingRight, and Atom::ParaLeft.

Referenced by Generator::generateThreadSafeness().

Here is the caller graph for this function:

tag()

QRegularExpression tag ( "</?@[^>]* , "  )

static

warnAboutUnknownDocumentedParams()

void warnAboutUnknownDocumentedParams ( const Node * node, const QSet< QString > & documentedNames, const QSet< QString > & allowedNames, ValidationContext context )

static

Warns about documented parameter names in node that don't exist in allowedNames.

Uses context to select appropriate wording.

Definition at line 109 of file generator.cpp.

Variable Documentation

amp

QLatin1String amp ( "&" )

static

gt

QLatin1String gt ( ">" )

static

lt

QLatin1String lt ( "<" )

static

quot

QLatin1String quot ( """ )

static