generator.cpp File Reference

(afa9c763b6a2c53d9861ac1153de29194956e291)

#include "generator.h"
#include "access.h"
#include "aggregate.h"
#include "classnode.h"
#include "codemarker.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 "node.h"
#include "openedlist.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 dependency graph for generator.cpp:

Go to the source code of this file.

Macros
#define	SKIP_CHAR(c)
#define	SKIP_SPACE

Functions
static QRegularExpression	tag ("</?@[^>]*>")
std::optional< QString >	formatStatus (const Node *node, QDocDatabase *qdb)
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;

Function Documentation

formatStatus()

std::optional< QString > formatStatus	(	const Node *	node,
		QDocDatabase *	qdb )

Returns a string representing status information of a node.

If a status description is returned, it is one of: \list

• Custom status set explicitly in node's documentation using {\meta {status} {}},
• 'Deprecated [since <version>]' (\deprecated [<version>]),
• 'Until <version>',
• 'Preliminary' (\preliminary), or
• The description adopted from associated module's state: {\modulestate {}}. \endlist

Otherwise, returns std::nullopt.

Definition at line 1138 of file generator.cpp.

References Node< _Tp >::Deprecated, Node< _Tp >::doc(), QDocDatabase::getModuleNode(), Doc::metaTagMap(), Node< _Tp >::Preliminary, and Node< _Tp >::status().

Here is the call graph for this function:

startNote()

static void startNote ( Text & text )

static

Definition at line 1429 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()

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

static

Variable Documentation

amp

static QLatin1String amp ( "&" )

static

gt

static QLatin1String gt ( ">" )

static

lt

static QLatin1String lt ( "<" )

static

quot

static QLatin1String quot ( """ )

static