NodeText Namespace Reference

Provides human-readable descriptions of QDoc nodes. More...

Enumerations
enum class	GrammaticalNumber { Singular , Plural }

Functions
QString	nodeTypeDescription (const Node *node, GrammaticalNumber number=GrammaticalNumber::Singular)
QString	nodeTypeDescription (const Node *node, GrammaticalNumber number)

Detailed Description

Provides human-readable descriptions of QDoc nodes.

Enumeration Type Documentation

GrammaticalNumber

enum class NodeText::GrammaticalNumber

strong

Enumerator
Singular
Plural

Definition at line 16 of file nodedescription.h.

Function Documentation

nodeTypeDescription() [1/2]

QString NodeText::nodeTypeDescription	(	const Node *	node,
		GrammaticalNumber	number )

Returns a human-readable description of node's type in the specified grammatical number. The default is Singular because most callers describe one node.

See also

NodeText::GrammaticalNumber

Definition at line 39 of file nodedescription.cpp.

References Function, Node< _Tp >::nodeType(), and SharedComment.

Here is the call graph for this function:

nodeTypeDescription() [2/2]

QString NodeText::nodeTypeDescription	(	const Node *	node,
		GrammaticalNumber	number = GrammaticalNumber::Singular )

Referenced by Generator::generateThreadSafeness().

Here is the caller graph for this function: