#include <generator.h>

Inheritance diagram for Generator:

Collaboration diagram for Generator:

Public Types
enum	ListType { Generic , Obsolete }
enum	Addendum { Invokable , PrivateSignal , QmlSignalHandler , AssociatedProperties , BindableProperty , OverloadNote }
enum class	AdmonitionPrefix : unsigned char { None , Note }
Public Types inherited from QRandomGenerator
typedef quint32	result_type
	A typedef to the type that operator() returns.

Public Member Functions
qreal	snippets_4_to_11 (int z, quint32 begin, quint32 end, const quint32 *seedBuffer, size_t len)
	Generator (Moc moc, ClassDef classDef, const QList< QByteArray > &metaTypes, const QHash< QByteArray, QByteArray > &knownQObjectClasses, const QHash< QByteArray, QByteArray > &knownGadgets, FILE *outfile=nullptr, bool requireCompleteTypes=false)
void	generateCode ()
qsizetype	registeredStringsCount ()
	Generator (FileResolver &file_resolver)
	Constructs the generator base class.
virtual	~Generator ()
	Destroys the generator after removing it from the list of output generators.
virtual bool	canHandleFormat (const QString &format)
virtual QString	format ()=0
virtual void	generateDocs ()
	Traverses the database recursively to generate all the documentation.
virtual void	initializeGenerator ()
	No-op base implementation.
virtual void	initializeFormat ()
	Reads format-specific variables from config, sets output (sub)directories, creates them on the filesystem and copies the template-specific files.
virtual void	terminateGenerator ()
virtual QString	typeString (const Node *node)
QString	fullDocumentLocation (const Node *node)
	Returns the full document location.
QString	linkForExampleFile (const QString &path, const QString &fileExt=QString())
	Constructs an href link from an example file name, which is a path to the example file.
virtual QString	fileBase (const Node *node) const
qreal	snippets_4_to_11 (int z, quint32 begin, quint32 end, const quint32 *seedBuffer, size_t len)
Public Member Functions inherited from QRandomGenerator
	QRandomGenerator (quint32 seedValue=1)
	Initializes this QRandomGenerator object with the value seedValue as the seed.
template<qsizetype N>
	QRandomGenerator (const quint32(&seedBuffer)[N])
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Initializes this QRandomGenerator object with the values found in the array seedBuffer as the seed.
	QRandomGenerator (const quint32 *seedBuffer, qsizetype len)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Initializes this QRandomGenerator object with len values found in the array seedBuffer as the seed.
Q_CORE_EXPORT	QRandomGenerator (std::seed_seq &sseq) noexcept
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Initializes this QRandomGenerator object with the seed sequence sseq as the seed.
Q_CORE_EXPORT	QRandomGenerator (const quint32 begin, const quint32 end)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Initializes this QRandomGenerator object with the values found in the range from begin to end as the seed.
Q_CORE_EXPORT	QRandomGenerator (const QRandomGenerator &other)
	Creates a copy of the generator state in the other object.
Q_CORE_EXPORT QRandomGenerator &	operator= (const QRandomGenerator &other)
	~QRandomGenerator ()=default
quint32	generate ()
	Generates a 32-bit random quantity and returns it.
quint64	generate64 ()
	Generates a 64-bit random quantity and returns it.
double	generateDouble ()
	Generates one random qreal in the canonical range [0, 1) (that is, inclusive of zero and exclusive of 1).
double	bounded (double highest)
	Generates one random double in the range between 0 (inclusive) and highest (exclusive).
quint32	bounded (quint32 highest)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Generates one random 32-bit quantity in the range between 0 (inclusive) and highest (exclusive).
quint32	bounded (quint32 lowest, quint32 highest)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Generates one random 32-bit quantity in the range between lowest (inclusive) and highest (exclusive).
int	bounded (int highest)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Generates one random 32-bit quantity in the range between 0 (inclusive) and highest (exclusive).
int	bounded (int lowest, int highest)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Generates one random 32-bit quantity in the range between lowest (inclusive) and highest (exclusive), both of which may be negative, but highest must be greater than lowest.
quint64	bounded (quint64 highest)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Generates one random 64-bit quantity in the range between 0 (inclusive) and highest (exclusive).
quint64	bounded (quint64 lowest, quint64 highest)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Generates one random 64-bit quantity in the range between lowest (inclusive) and highest (exclusive).
qint64	bounded (qint64 highest)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Generates one random 64-bit quantity in the range between 0 (inclusive) and highest (exclusive).
qint64	bounded (qint64 lowest, qint64 highest)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Generates one random 64-bit quantity in the range between lowest (inclusive) and highest (exclusive), both of which may be negative, but highest must be greater than lowest.
qint64	bounded (int lowest, qint64 highest)
qint64	bounded (qint64 lowest, int highest)
quint64	bounded (unsigned lowest, quint64 highest)
quint64	bounded (quint64 lowest, unsigned highest)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function exists to help with overload resolution when the types of the parameters don't exactly match.
template<typename UInt, IfValidUInt< UInt > = true>
void	fillRange (UInt *buffer, qsizetype count)
	Generates count 32- or 64-bit quantities (depending on the type `UInt`) and stores them in the buffer pointed by buffer.
template<typename UInt, size_t N, IfValidUInt< UInt > = true>
void	fillRange (UInt(&buffer)[N])
	Generates `N` 32- or 64-bit quantities (depending on the type `UInt`) and stores them in the buffer array.
template<typename ForwardIterator>
void	generate (ForwardIterator begin, ForwardIterator end)
	Generates 32-bit quantities and stores them in the range between begin and end.
void	generate (quint32 begin, quint32 end)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
result_type	operator() ()
	Generates a 32-bit random quantity and returns it.
void	seed (quint32 s=1)
	Reseeds this object using the value seed as the seed.
void	seed (std::seed_seq &sseq) noexcept
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Reseeds this object using the seed sequence seed as the seed.
Q_CORE_EXPORT void	discard (unsigned long long z)
	Discards the next z entries from the sequence.

Static Public Member Functions
static QString	exampleFileTitle (const ExampleNode *relative, const QString &fileName)
	Helper function to construct a title for a file or image page included in an example.
static Generator *	currentGenerator ()
static Generator *	generatorForFormat (const QString &format)
static void	initialize ()
static const QString &	outputDir ()
static const QString &	outputSubdir ()
static void	terminate ()
static const QStringList &	outputFileNames ()
static bool	noLinkErrors ()
static bool	autolinkErrors ()
static QString	defaultModuleName ()
static void	resetUseOutputSubdirs ()
static bool	useOutputSubdirs ()
static void	setQmlTypeContext (QmlTypeNode *t)
static QmlTypeNode *	qmlTypeContext ()
static QString	cleanRef (const QString &ref, bool xmlCompliant=false)
	Clean the given ref to be used as an HTML anchor or an `xml:id`.
static QString	plainCode (const QString &markedCode)
static Qt::SortOrder	sortOrder (const QString &str)
static void	addNodeLink (Text &text, const QString &nodeRef, const QString &linkText)
	Adds a formatted link to the specified text stream.
static void	addNodeLink (Text &text, const INode *node, const QString &linkText=QString())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This convenience overload automatically obtains the node reference string using stringForNode().
Static Public Member Functions inherited from QRandomGenerator
static constexpr result_type	min ()
	Returns the minimum value that QRandomGenerator may ever generate.
static constexpr result_type	max ()
	Returns the maximum value that QRandomGenerator may ever generate.
static Q_DECL_CONST_FUNCTION QRandomGenerator *	system ()
	\threadsafe
static Q_DECL_CONST_FUNCTION QRandomGenerator *	global ()
	\threadsafe
static QRandomGenerator	securelySeeded ()
	Returns a new QRandomGenerator object that was securely seeded with QRandomGenerator::system().

Protected Member Functions
void	beginSubPage (const Node *node, const QString &fileName)
	Creates the file named fileName in the output directory.
void	endSubPage ()
	Flush the text stream associated with the subpage, and then pop it off the text stream stack and delete it.
virtual QString	fileExtension () const =0
virtual void	generateExampleFilePage (const Node , ResolvedFile, CodeMarker =nullptr)
virtual void	generateAlsoList (const Node node, CodeMarker marker)
virtual void	generateAlsoList (const Node *node)
virtual qsizetype	generateAtom (const Atom , const Node , CodeMarker *)
virtual void	generateBody (const Node node, CodeMarker marker)
	Generate the body of the documentation from the qdoc comment found with the entity represented by the node.
virtual void	generateCppReferencePage (Aggregate , CodeMarker )
virtual void	generateProxyPage (Aggregate , CodeMarker )
virtual void	generateQmlTypePage (QmlTypeNode , CodeMarker )
virtual void	generatePageNode (PageNode , CodeMarker )
virtual void	generateCollectionNode (CollectionNode , CodeMarker )
virtual void	generateGenericCollectionPage (CollectionNode , CodeMarker )
virtual void	generateDocumentation (Node *node)
	Recursive writing of HTML files from the root node.
virtual bool	generateText (const Text &text, const Node relative, CodeMarker marker)
	Generate the documentation for relative.
virtual bool	generateText (const Text &text, const Node *relative)
virtual int	skipAtoms (const Atom *atom, Atom::AtomType type) const
void	initializeTextOutput ()
	Resets the variables used during text output.
QString	fileName (const Node *node, const QString &extension=QString()) const
	If the node has a URL, return the URL as the file name.
QMap< QString, QString > &	formattingLeftMap ()
QMap< QString, QString > &	formattingRightMap ()
const Atom *	generateAtomList (const Atom atom, const Node relative, CodeMarker *marker, bool generate, int &numGeneratedAtoms)
void	generateEnumValuesForQmlReference (const Node node, CodeMarker marker)
void	generateRequiredLinks (const Node node, CodeMarker marker)
	Generates either a link to the project folder for example node, or a list of links files/images if 'url.examples config' variable is not defined.
void	generateLinkToExample (const ExampleNode en, CodeMarker marker, const QString &exampleUrl)
	Generates an external link to the project folder for example node.
virtual void	generateFileList (const ExampleNode en, CodeMarker marker, bool images)
	This function is called when the documentation for an example is being formatted.
void	generateSince (const Node node, CodeMarker marker)
void	generateNoexceptNote (const Node node, CodeMarker marker)
void	generateStatus (const Node node, CodeMarker marker)
virtual void	generateAddendum (const Node node, Addendum type, CodeMarker marker, AdmonitionPrefix prefix)
	Generates an addendum note of type type for node, using marker as the code marker.
virtual void	generateAddendum (const Node node, Addendum type, CodeMarker marker)
void	generateThreadSafeness (const Node node, CodeMarker marker)
	Generates text that explains how threadsafe and/or reentrant node is.
bool	generateComparisonCategory (const Node node, CodeMarker marker=nullptr)
bool	generateComparisonList (const Node *node)
	Generates a list of types that compare to node with the comparison category that applies for the relationship, followed by (an optional) descriptive text.
QString	generateOverloadSnippet (const FunctionNode *func)
	Generates a contextual code snippet for connecting to an overloaded signal or slot.
QString	generateObjectName (const QString &className)
	Generates an appropriate object name for code snippets based on the class name.
QString	indent (int level, const QString &markedCode)
QTextStream &	out ()
QString	outFileName ()
bool	parseArg (const QString &src, const QString &tag, int pos, int n, QStringView contents, QStringView *par1=nullptr)
void	unknownAtom (const Atom *atom)
int	appendSortedQmlNames (Text &text, const Node base, const QStringList &knownTypes, const QList< Node > &subs)
void	appendFullName (Text &text, const Node apparentNode, const Node relative, const Node *actualNode=nullptr)
void	appendFullName (Text &text, const Node apparentNode, const QString &fullName, const Node actualNode)
int	appendSortedNames (Text &text, const ClassNode *classe, const QList< RelatedClass > &classes)
void	appendSignature (Text &text, const Node *node)
	Append the signature for the function named in node to text, so that is a link to the documentation for that function.
void	signatureList (const QList< Node * > &nodes, const Node relative, CodeMarker marker)
	Generate a bullet list of function signatures.
void	addImageToCopy (const ExampleNode *en, const ResolvedFile &resolved_file)
Protected Member Functions inherited from QRandomGenerator
	QRandomGenerator (System)

Static Protected Member Functions
static QFile *	openSubPageFile (const PageNode *node, const QString &fileName)
	Creates the file named fileName in the output directory and returns a QFile pointing to this file.
static bool	matchAhead (const Atom *atom, Atom::AtomType expectedAtomType)
static QString	outputPrefix (const Node *node)
static QString	outputSuffix (const Node *node)
static void	supplementAlsoList (const Node *node, QList< Text > &alsoList)
static QString	trimmedTrailing (const QString &string, const QString &prefix, const QString &suffix)
	Trims trailing whitespace off the string and returns the trimmed string.
static QString	formatSince (const Node *node)
static bool	hasExceptions (const Node node, QList< Node > &reentrant, QList< Node * > &threadsafe, QList< Node * > &nonreentrant)
static bool	comparePaths (const QString &a, const QString &b)
static bool	appendTrademark (const Atom *atom)
	Returns `true` if a trademark symbol should be appended to the output as determined by atom.
static std::optional< std::pair< QString, QString > >	cmakeRequisite (const CollectionNode *cn)
	Generate the CMake requisite for the node cn, i.e.

Protected Attributes
QString	naturalLanguage
QString	tagFile_
QStack< QTextStream * >	outStreamStack
FileResolver &	file_resolver
QDocDatabase *	m_qdb { nullptr }
bool	m_inLink { false }
bool	m_inContents { false }
bool	m_inSectionHeading { false }
bool	m_inTableHeader { false }
bool	m_threeColumnEnumValueTable { true }
bool	m_quoting { false }
int	m_numTableRows { 0 }
QString	m_link {}
QString	m_sectionNumber {}

Additional Inherited Members
Protected Types inherited from QRandomGenerator
enum	System

Detailed Description

Definition at line 32 of file src_corelib_global_qrandom.cpp.

Member Enumeration Documentation

◆ Addendum

enum Generator::Addendum

Enumerator
Invokable
PrivateSignal
QmlSignalHandler
AssociatedProperties
BindableProperty
OverloadNote

Definition at line 42 of file generator.h.

◆ AdmonitionPrefix

enum class Generator::AdmonitionPrefix : unsigned char

strong

Enumerator
None
Note

Definition at line 51 of file generator.h.

◆ ListType

enum Generator::ListType

Enumerator
Generic
Obsolete

Definition at line 40 of file generator.h.

Constructor & Destructor Documentation

◆ Generator() [1/2]

Generator::Generator	(	Moc *	moc,
		ClassDef *	classDef,
		const QList< QByteArray > &	metaTypes,
		const QHash< QByteArray, QByteArray > &	knownQObjectClasses,
		const QHash< QByteArray, QByteArray > &	knownGadgets,
		FILE *	outfile = nullptr,
		bool	requireCompleteTypes = false )

Definition at line 81 of file generator.cpp.

References Generator().

Referenced by Generator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Generator() [2/2]

Generator::Generator ( FileResolver & file_resolver )

Constructs the generator base class.

Prepends the newly constructed generator to the list of output generators. Sets a pointer to the QDoc database singleton, which is available to the generator subclasses.

Definition at line 80 of file generator.cpp.

References file_resolver.

◆ ~Generator()

Generator::~Generator ( )

virtual

Destroys the generator after removing it from the list of output generators.

Definition at line 91 of file generator.cpp.

Member Function Documentation

◆ addImageToCopy()

void Generator::addImageToCopy	(	const ExampleNode *	en,
		const ResolvedFile &	resolved_file )

protected

Definition at line 914 of file generator.cpp.

References Node< _Tp >::location().

Here is the call graph for this function:

◆ addNodeLink() [1/2]

void Generator::addNodeLink	(	Text &	text,
		const INode *	node,
		const QString &	linkText = QString() )

static

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This convenience overload automatically obtains the node reference string using stringForNode().

If linkText is empty, the node's name is used as the link text; otherwise, the specified linkText is used.

See also: stringForNode()

Definition at line 2402 of file generator.cpp.

◆ addNodeLink() [2/2]

void Generator::addNodeLink	(	Text &	text,
		const QString &	nodeRef,
		const QString &	linkText )

static

Adds a formatted link to the specified text stream.

This function creates a sequence of Atom objects that together form a link and appends them to the text. The nodeRef parameter specifies the target of the link (typically obtained via stringForNode()), and linkText specifies the visible text for the link.

See also: Atom, stringForNode()

Definition at line 2386 of file generator.cpp.

References Atom::FormattingLeft, Atom::FormattingRight, Atom::LinkNode, and Atom::String.

◆ appendFullName() [1/2]

void Generator::appendFullName	(	Text &	text,
		const Node *	apparentNode,
		const Node *	relative,
		const Node *	actualNode = nullptr )

protected

Definition at line 96 of file generator.cpp.

◆ appendFullName() [2/2]

void Generator::appendFullName	(	Text &	text,
		const Node *	apparentNode,
		const QString &	fullName,
		const Node *	actualNode )

protected

Definition at line 105 of file generator.cpp.

◆ appendSignature()

void Generator::appendSignature	(	Text &	text,
		const Node *	node )

protected

Append the signature for the function named in node to text, so that is a link to the documentation for that function.

Definition at line 119 of file generator.cpp.

References Node< _Tp >::SignaturePlain.

◆ appendSortedNames()

int Generator::appendSortedNames	(	Text &	text,
		const ClassNode *	classe,
		const QList< RelatedClass > &	classes )

protected

Definition at line 144 of file generator.cpp.

◆ appendSortedQmlNames()

int Generator::appendSortedQmlNames	(	Text &	text,
		const Node *	base,
		const QStringList &	knownTypes,
		const QList< Node * > &	subs )

protected

Definition at line 165 of file generator.cpp.

◆ appendTrademark()

bool Generator::appendTrademark ( const Atom * atom )

staticprotected

Returns true if a trademark symbol should be appended to the output as determined by atom.

Trademarks are tracked via the use of the \tm formatting command.

Returns true if:

\list

atom is of type Atom::FormattingRight containing ATOM_FORMATTING_TRADEMARK, and
The trademarked string is the first appearance on the current sub-page. \endlist

Definition at line 1558 of file generator.cpp.

References Atom::FormattingRight, and Atom::type().

Referenced by WebXMLGenerator::addAtomElements(), and HtmlGenerator::generateAtom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ autolinkErrors()

bool Generator::autolinkErrors ( )

inlinestatic

Definition at line 79 of file generator.h.

Referenced by HtmlGenerator::generateAtom().

Here is the caller graph for this function:

◆ beginSubPage()

void Generator::beginSubPage	(	const Node *	node,
		const QString &	fileName )

protected

Creates the file named fileName in the output directory.

Attaches a QTextStream to the created file, which is written to all over the place using out().

Definition at line 237 of file generator.cpp.

References Node< _Tp >::isPageNode().

Here is the call graph for this function:

◆ canHandleFormat()

virtual bool Generator::canHandleFormat ( const QString & format )

inlinevirtual

Definition at line 60 of file generator.h.

References format().

Here is the call graph for this function:

◆ cleanRef()

QString Generator::cleanRef	(	const QString &	ref,
		bool	xmlCompliant = false )

static

Clean the given ref to be used as an HTML anchor or an xml:id.

If xmlCompliant is set to true, a stricter process is used, as XML is more rigorous in what it accepts. Otherwise, if xmlCompliant is set to false, the basic HTML transformations are applied.

More specifically, only XML NCNames are allowed (https://www.w3.org/TR/REC-xml-names/#NT-NCName).

Definition at line 398 of file generator.cpp.

◆ cmakeRequisite()

std::optional< std::pair< QString, QString > > Generator::cmakeRequisite ( const CollectionNode * cn )

staticprotected

Generate the CMake requisite for the node cn, i.e.

the the find_package and target_link_libraries calls to use it.

If only cmakepackage is set it will look like

\badcode find_package(Foo REQUIRED) target_link_libraries(mytarget PRIVATE Foo:Foo)

If no cmakepackage is set Qt6 is assumed.

If cmakecomponent is set it will look like

\badcode find_package(Qt6 REQUIRED COMPONENTS Bar) target_link_libraries(mytarget PRIVATE Qt6::Bar)

If cmaketargetitem is set the item in target_link_libraries will be set accordingly

\badcode find_package(Qt6 REQUIRED COMPONENTS Bar) target_link_libraries(mytarget PRIVATE My::Target)

Returns a pair consisting of the find package line and link libraries line.

If no sensible requisite can be created (i.e. both cmakecomponent and cmakepackage are unset) std::nullopt is returned.

Definition at line 2343 of file generator.cpp.

◆ comparePaths()

bool Generator::comparePaths	(	const QString &	a,
		const QString &	b )

inlinestaticprotected

Definition at line 178 of file generator.h.

◆ currentGenerator()

Generator * Generator::currentGenerator ( )

inlinestatic

Definition at line 71 of file generator.h.

Referenced by fullDocumentLocation().

Here is the caller graph for this function:

◆ defaultModuleName()

QString Generator::defaultModuleName ( )

inlinestatic

Definition at line 80 of file generator.h.

◆ endSubPage()

void Generator::endSubPage ( )

protected

Flush the text stream associated with the subpage, and then pop it off the text stream stack and delete it.

This terminates output of the subpage.

Definition at line 250 of file generator.cpp.

Referenced by WebXMLGenerator::generateCppReferencePage(), generateDocumentation(), HtmlGenerator::generateExampleFilePage(), WebXMLGenerator::generateExampleFilePage(), and WebXMLGenerator::generatePageNode().

Here is the caller graph for this function:

◆ exampleFileTitle()

QString Generator::exampleFileTitle	(	const ExampleNode *	relative,
		const QString &	fileName )

static

Helper function to construct a title for a file or image page included in an example.

Definition at line 348 of file generator.cpp.

◆ fileBase()

QString Generator::fileBase ( const Node * node ) const

virtual

Reimplemented in HtmlGenerator, and WebXMLGenerator.

Definition at line 257 of file generator.cpp.

References Node< _Tp >::createContext(), Node< _Tp >::hasFileNameBase(), Node< _Tp >::isCollectionNode(), Node< _Tp >::isExample(), Node< _Tp >::isModule(), Node< _Tp >::isPageNode(), Node< _Tp >::isProxyNode(), Node< _Tp >::isQmlBasicType(), Node< _Tp >::isQmlModule(), Node< _Tp >::isQmlType(), Node< _Tp >::isTextPageNode(), Node< _Tp >::logicalModule(), and Node< _Tp >::parent().

Here is the call graph for this function:

◆ fileExtension()

virtual QString Generator::fileExtension ( ) const

nodiscardprotectedpure virtual

Implemented in DocBookGenerator, HtmlGenerator, and WebXMLGenerator.

◆ fileName()

QString Generator::fileName	(	const Node *	node,
		const QString &	extension = QString() ) const

protected

If the node has a URL, return the URL as the file name.

Otherwise, construct the file name from the fileBase() and either the provided extension or fileExtension(), and return the constructed name.

Definition at line 367 of file generator.cpp.

References Node< _Tp >::isCollectionNode(), and Node< _Tp >::isTextPageNode().

Here is the call graph for this function:

◆ format()

virtual QString Generator::format ( )

pure virtual

Implemented in DocBookGenerator, HtmlGenerator, and WebXMLGenerator.

Referenced by canHandleFormat().

Here is the caller graph for this function:

◆ formatSince()

QString Generator::formatSince ( const Node * node )

staticprotected

Definition at line 1159 of file generator.cpp.

◆ formattingLeftMap()

QMap< QString, QString > & Generator::formattingLeftMap ( )

protected

Definition at line 453 of file generator.cpp.

◆ formattingRightMap()

QMap< QString, QString > & Generator::formattingRightMap ( )

protected

Definition at line 458 of file generator.cpp.

◆ fullDocumentLocation()

QString Generator::fullDocumentLocation ( const Node * node )

Returns the full document location.

Definition at line 466 of file generator.cpp.

References currentGenerator(), Enum, Function, Group, HeaderFile, Node< _Tp >::isAttached(), Node< _Tp >::isClassNode(), Node< _Tp >::isCollectionNode(), Node< _Tp >::isDeprecated(), FunctionNode::isDtor(), Node< _Tp >::isNamespace(), Node< _Tp >::isPropertyGroup(), Node< _Tp >::isQmlType(), Node< _Tp >::isTextPageNode(), FunctionNode::metaness(), Module, Node< _Tp >::nodeType(), Page, Node< _Tp >::parent(), Property, QmlEnum, FunctionNode::QmlMethod, QmlModule, QmlProperty, FunctionNode::QmlSignal, FunctionNode::QmlSignalHandler, QmlType, SharedComment, TypeAlias, Typedef, and Variable.

Here is the call graph for this function:

◆ generateAddendum() [1/2]

virtual void Generator::generateAddendum	(	const Node *	node,
		Addendum	type,
		CodeMarker *	marker )

inlineprotectedvirtual

Definition at line 136 of file generator.h.

References generateAddendum(), and Note.

Referenced by generateBody().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateAddendum() [2/2]

void Generator::generateAddendum	(	const Node *	node,
		Addendum	type,
		CodeMarker *	marker,
		AdmonitionPrefix	prefix )

protectedvirtual

Generates an addendum note of type type for node, using marker as the code marker.

Reimplemented in DocBookGenerator.

Definition at line 1308 of file generator.cpp.

References AssociatedProperties, Atom::AutoLink, PropertyNode::Bindable, BindableProperty, Atom::Code, Atom::DivRight, Node< _Tp >::doc(), Atom::FormattingLeft, Atom::FormattingRight, generateText(), PropertyNode::Getter, Invokable, Node< _Tp >::isClassNode(), Node< _Tp >::isFunction(), Node< _Tp >::isNamespace(), FunctionNode::isSignal(), FunctionNode::isSlot(), Atom::Link, Node< _Tp >::nodeNameLessThan(), None, Note, PropertyNode::Notifier, OverloadNote, Atom::ParaLeft, Atom::ParaRight, Node< _Tp >::parent(), PrivateSignal, QmlSignalHandler, PropertyNode::Resetter, and PropertyNode::Setter.

Referenced by generateAddendum(), and generateBody().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateAlsoList() [1/2]

virtual void Generator::generateAlsoList ( const Node * node )

inlineprotectedvirtual

Reimplemented in DocBookGenerator.

Definition at line 96 of file generator.h.

References generateAlsoList().

Here is the call graph for this function:

◆ generateAlsoList() [2/2]

void Generator::generateAlsoList	(	const Node *	node,
		CodeMarker *	marker )

protectedvirtual

Definition at line 591 of file generator.cpp.

References Node< _Tp >::doc(), Atom::FormattingLeft, Atom::FormattingRight, generateText(), Atom::ParaLeft, and Atom::ParaRight.

Referenced by generateAlsoList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateAtom()

virtual qsizetype Generator::generateAtom	(	const Atom *	,
		const Node *	,
		CodeMarker *	)

inlineprotectedvirtual

Reimplemented in DocBookGenerator, HtmlGenerator, and WebXMLGenerator.

Definition at line 97 of file generator.h.

◆ generateAtomList()

const Atom * Generator::generateAtomList	(	const Atom *	atom,
		const Node *	relative,
		CodeMarker *	marker,
		bool	generate,
		int &	numGeneratedAtoms )

protected

Definition at line 621 of file generator.cpp.

References Atom::FormatElse, Atom::FormatEndif, Atom::FormatIf, generateAtomList(), Atom::next(), and Atom::type().

Referenced by generateAtomList(), DocBookGenerator::generateText(), and generateText().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateBody()

void Generator::generateBody	(	const Node *	node,
		CodeMarker *	marker )

protectedvirtual

Generate the body of the documentation from the qdoc comment found with the entity represented by the node.

Reimplemented in DocBookGenerator.

Definition at line 670 of file generator.cpp.

Referenced by HtmlGenerator::generateCollectionNode(), HtmlGenerator::generateCppReferencePage(), HtmlGenerator::generatePageNode(), HtmlGenerator::generateProxyPage(), and HtmlGenerator::generateQmlTypePage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateCode()

void Generator::generateCode ( )

Definition at line 226 of file generator.cpp.

References ClassDef::hasQGadget, ClassDef::hasQNamespace, ClassDef::hasQObject, FunctionDef::Private, and ClassDef::requireCompleteMethodTypes.

◆ generateCollectionNode()

virtual void Generator::generateCollectionNode	(	CollectionNode *	,
		CodeMarker *	)

inlineprotectedvirtual

Reimplemented in DocBookGenerator, and HtmlGenerator.

Definition at line 103 of file generator.h.

Referenced by generateDocumentation().

Here is the caller graph for this function:

◆ generateComparisonCategory()

bool Generator::generateComparisonCategory	(	const Node *	node,
		CodeMarker *	marker = nullptr )

protected

Generates text that describes the comparison category of node. The CodeMarker marker is passed along to generateText().

Definition at line 1674 of file generator.cpp.

References Node< _Tp >::comparisonCategory(), and generateText().

Referenced by HtmlGenerator::generateCppReferencePage(), and DocBookGenerator::generateHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateComparisonList()

bool Generator::generateComparisonList ( const Node * node )

protected

Generates a list of types that compare to node with the comparison category that applies for the relationship, followed by (an optional) descriptive text.

Returns true if text was generated, false otherwise.

Definition at line 1699 of file generator.cpp.

References Node< _Tp >::doc(), generateText(), and Text::isEmpty().

Referenced by HtmlGenerator::generateCppReferencePage(), and DocBookGenerator::generateHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateCppReferencePage()

virtual void Generator::generateCppReferencePage	(	Aggregate *	,
		CodeMarker *	)

inlineprotectedvirtual

Reimplemented in DocBookGenerator, HtmlGenerator, and WebXMLGenerator.

Definition at line 99 of file generator.h.

Referenced by generateDocumentation().

Here is the caller graph for this function:

◆ generateDocs()

void Generator::generateDocs ( )

virtual

Traverses the database recursively to generate all the documentation.

Reimplemented in HtmlGenerator.

Definition at line 1731 of file generator.cpp.

References generateDocumentation(), m_qdb, and QDocDatabase::primaryTreeRoot().

Referenced by HtmlGenerator::generateDocs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateDocumentation()

void Generator::generateDocumentation ( Node * node )

protectedvirtual

Recursive writing of HTML files from the root node.

Reimplemented in DocBookGenerator, and WebXMLGenerator.

Definition at line 1011 of file generator.cpp.

References Aggregate::childNodes(), Node< _Tp >::createContext(), Node< _Tp >::docMustBeGenerated(), endSubPage(), generateCollectionNode(), generateCppReferencePage(), generateGenericCollectionPage(), generatePageNode(), generateProxyPage(), generateQmlTypePage(), Node< _Tp >::isAggregate(), Node< _Tp >::isClassNode(), Node< _Tp >::isCollectionNode(), Node< _Tp >::isExternalPage(), Node< _Tp >::isGenericCollection(), Node< _Tp >::isHeader(), InclusionFilter::isIncluded(), Node< _Tp >::isIndexNode(), Node< _Tp >::isNamespace(), Node< _Tp >::isProxyNode(), Node< _Tp >::isQmlType(), Node< _Tp >::isTextPageNode(), Node< _Tp >::location(), m_qdb, QDocDatabase::mergeCollections(), Node< _Tp >::parent(), and CollectionNode::wasSeen().

Referenced by generateDocs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateEnumValuesForQmlReference()

void Generator::generateEnumValuesForQmlReference	(	const Node *	node,
		CodeMarker *	marker )

protected

Definition at line 2165 of file generator.cpp.

References Node< _Tp >::doc(), NativeEnum::enumNode(), generateText(), generateText(), Text::isEmpty(), Atom::ListLeft, Atom::ListRight, and NativeEnumInterface::nativeEnum().

Referenced by DocBookGenerator::generateBody(), and generateBody().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateExampleFilePage()

virtual void Generator::generateExampleFilePage	(	const Node *	,
		ResolvedFile	,
		CodeMarker *	= nullptr )

inlineprotectedvirtual

Reimplemented in DocBookGenerator, HtmlGenerator, and WebXMLGenerator.

Definition at line 94 of file generator.h.

◆ generateFileList()

void Generator::generateFileList	(	const ExampleNode *	en,
		CodeMarker *	marker,
		bool	images )

protectedvirtual

This function is called when the documentation for an example is being formatted.

It outputs a list of files for the example, which can be the example's source files or the list of images used by the example. The images are copied into a subtree of {...doc/html/images/used-in-examples/...}

Definition at line 952 of file generator.cpp.

References OpenedList::OpenedList(), OpenedList::Bullet, Atom::ExampleFileLink, Atom::ExampleImageLink, Atom::ListLeft, Atom::ListRight, Atom::ParaLeft, Atom::ParaRight, and OpenedList::styleString().

Referenced by generateRequiredLinks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateGenericCollectionPage()

virtual void Generator::generateGenericCollectionPage	(	CollectionNode *	,
		CodeMarker *	)

inlineprotectedvirtual

Reimplemented in DocBookGenerator, and HtmlGenerator.

Definition at line 104 of file generator.h.

Referenced by generateDocumentation().

Here is the caller graph for this function:

◆ generateLinkToExample()

void Generator::generateLinkToExample	(	const ExampleNode *	en,
		CodeMarker *	marker,
		const QString &	baseUrl )

protected

Generates an external link to the project folder for example node.

The path to the example replaces a placeholder '\1' character if one is found in the baseUrl string. If no such placeholder is found, the path is appended to baseUrl, after a '/' character if baseUrl did not already end in one.

Definition at line 875 of file generator.cpp.

References Node< _Tp >::doc(), Atom::FormattingLeft, Atom::FormattingRight, generateText(), Atom::Link, Atom::ParaLeft, Atom::ParaRight, and Atom::String.

Here is the call graph for this function:

◆ generateNoexceptNote()

void Generator::generateNoexceptNote	(	const Node *	node,
		CodeMarker *	marker )

protected

Definition at line 1225 of file generator.cpp.

References Node< _Tp >::isSharedCommentNode().

Here is the call graph for this function:

◆ generateObjectName()

QString Generator::generateObjectName ( const QString & className )

protected

Generates an appropriate object name for code snippets based on the class name.

Converts class names like "QComboBox" to "comboBox".

Definition at line 2442 of file generator.cpp.

◆ generateOverloadSnippet()

QString Generator::generateOverloadSnippet ( const FunctionNode * func )

protected

Generates a contextual code snippet for connecting to an overloaded signal or slot.

Returns an empty string if the function is not a signal or slot.

Definition at line 2414 of file generator.cpp.

References FunctionNode::isSignal(), and FunctionNode::isSlot().

Here is the call graph for this function:

◆ generatePageNode()

virtual void Generator::generatePageNode	(	PageNode *	,
		CodeMarker *	)

inlineprotectedvirtual

Reimplemented in DocBookGenerator, HtmlGenerator, and WebXMLGenerator.

Definition at line 102 of file generator.h.

Referenced by generateDocumentation().

Here is the caller graph for this function:

◆ generateProxyPage()

virtual void Generator::generateProxyPage	(	Aggregate *	,
		CodeMarker *	)

inlineprotectedvirtual

Reimplemented in DocBookGenerator, and HtmlGenerator.

Definition at line 100 of file generator.h.

Referenced by generateDocumentation().

Here is the caller graph for this function:

◆ generateQmlTypePage()

virtual void Generator::generateQmlTypePage	(	QmlTypeNode *	,
		CodeMarker *	)

inlineprotectedvirtual

Reimplemented in DocBookGenerator, and HtmlGenerator.

Definition at line 101 of file generator.h.

Referenced by generateDocumentation().

Here is the caller graph for this function:

◆ generateRequiredLinks()

void Generator::generateRequiredLinks	(	const Node *	node,
		CodeMarker *	marker )

protected

Generates either a link to the project folder for example node, or a list of links files/images if 'url.examples config' variable is not defined.

Does nothing for non-example nodes.

Definition at line 850 of file generator.cpp.

References generateFileList(), Node< _Tp >::isExample(), and PageNode::noAutoList().

Referenced by WebXMLGenerator::append(), and generateBody().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateSince()

void Generator::generateSince	(	const Node *	node,
		CodeMarker *	marker )

protected

Definition at line 1215 of file generator.cpp.

References generateText().

Referenced by HtmlGenerator::generateCollectionNode(), and HtmlGenerator::generateCppReferencePage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateStatus()

void Generator::generateStatus	(	const Node *	node,
		CodeMarker *	marker )

protected

Definition at line 1252 of file generator.cpp.

References Node< _Tp >::Active, Node< _Tp >::Deprecated, Atom::FormattingLeft, Atom::FormattingRight, generateText(), Node< _Tp >::Internal, Node< _Tp >::isAggregate(), Node< _Tp >::isModule(), Node< _Tp >::isQmlModule(), Node< _Tp >::isQmlNode(), Atom::ParaLeft, Atom::ParaRight, and Node< _Tp >::status().

Referenced by HtmlGenerator::generateCollectionNode(), HtmlGenerator::generateCppReferencePage(), and HtmlGenerator::generateQmlTypePage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateText() [1/2]

virtual bool Generator::generateText	(	const Text &	text,
		const Node *	relative )

inlineprotectedvirtual

Reimplemented in DocBookGenerator.

Definition at line 107 of file generator.h.

References generateText().

Referenced by generateEnumValuesForQmlReference().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateText() [2/2]

bool Generator::generateText	(	const Text &	text,
		const Node *	relative,
		CodeMarker *	marker )

protectedvirtual

Generate the documentation for relative.

i.e. relative is the node that represents the entity where a qdoc comment was found, and text represents the qdoc comment.

Definition at line 1492 of file generator.cpp.

References Text::firstAtom(), generateAtomList(), and initializeTextOutput().

Referenced by generateAddendum(), generateAlsoList(), generateBody(), generateComparisonCategory(), generateComparisonList(), generateEnumValuesForQmlReference(), generateLinkToExample(), generateSince(), generateStatus(), generateText(), generateThreadSafeness(), and signatureList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateThreadSafeness()

void Generator::generateThreadSafeness	(	const Node *	node,
		CodeMarker *	marker )

protected

Generates text that explains how threadsafe and/or reentrant node is.

Definition at line 1584 of file generator.cpp.

References Text::clear(), Atom::FormattingLeft, Atom::FormattingRight, generateText(), Node< _Tp >::isAggregate(), Atom::Link, Atom::ParaRight, Node< _Tp >::Reentrant, startNote(), Node< _Tp >::ThreadSafe, Node< _Tp >::threadSafeness(), and Node< _Tp >::UnspecifiedSafeness.

Referenced by HtmlGenerator::generateCppReferencePage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generatorForFormat()

Generator * Generator::generatorForFormat ( const QString & format )

static

Definition at line 1737 of file generator.cpp.

◆ hasExceptions()

bool Generator::hasExceptions	(	const Node *	node,
		QList< Node * > &	reentrant,
		QList< Node * > &	threadsafe,
		QList< Node * > &	nonreentrant )

staticprotected

Definition at line 1513 of file generator.cpp.

References Aggregate::childNodes(), and Node< _Tp >::threadSafeness().

Here is the call graph for this function:

◆ indent()

QString Generator::indent	(	int	level,
		const QString &	markedCode )

protected

Definition at line 1746 of file generator.cpp.

◆ initialize()

void Generator::initialize ( )

static

Definition at line 1770 of file generator.cpp.

References ConfigVar::asBool().

Referenced by processQdocconfFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initializeFormat()

void Generator::initializeFormat ( )

virtual

Reads format-specific variables from config, sets output (sub)directories, creates them on the filesystem and copies the template-specific files.

Definition at line 1891 of file generator.cpp.

References Location::Location(), ConfigVar::asBool(), Config::generating(), m_quoting, Config::preparing(), resetUseOutputSubdirs(), and useOutputSubdirs().

Here is the call graph for this function:

◆ initializeGenerator()

void Generator::initializeGenerator ( )

virtual

No-op base implementation.

Subclasses may override to perform generator-specific initialization.

Reimplemented in DocBookGenerator, HtmlGenerator, and WebXMLGenerator.

Definition at line 1944 of file generator.cpp.

Referenced by DocBookGenerator::initializeGenerator(), and HtmlGenerator::initializeGenerator().

Here is the caller graph for this function:

◆ initializeTextOutput()

void Generator::initializeTextOutput ( )

protected

Resets the variables used during text output.

Definition at line 2102 of file generator.cpp.

References m_inContents, m_inLink, m_inSectionHeading, m_inTableHeader, m_numTableRows, and m_threeColumnEnumValueTable.

Referenced by DocBookGenerator::generateText(), and generateText().

Here is the caller graph for this function:

◆ linkForExampleFile()

QString Generator::linkForExampleFile	(	const QString &	path,
		const QString &	fileExt = QString() )

Constructs an href link from an example file name, which is a path to the example file.

If fileExt is empty (default value), retrieve the file extension from the generator.

Definition at line 333 of file generator.cpp.

◆ matchAhead()

bool Generator::matchAhead	(	const Atom *	atom,
		Atom::AtomType	expectedAtomType )

staticprotected

Definition at line 1949 of file generator.cpp.

References Atom::next(), and Atom::type().

Referenced by DocBookGenerator::generateAtom(), and HtmlGenerator::generateAtom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ noLinkErrors()

bool Generator::noLinkErrors ( )

inlinestatic

Definition at line 78 of file generator.h.

Referenced by HtmlGenerator::generateAtom().

Here is the caller graph for this function:

◆ openSubPageFile()

QFile * Generator::openSubPageFile	(	const PageNode *	node,
		const QString &	fileName )

staticprotected

Creates the file named fileName in the output directory and returns a QFile pointing to this file.

In particular, this method deals with errors when opening the file: the returned QFile is always valid and can be written to.

See also: beginSubPage()

Definition at line 198 of file generator.cpp.

References Node< _Tp >::location().

Here is the call graph for this function:

◆ out()

QTextStream & Generator::out ( )

protected

Referenced by HtmlGenerator::generateAtom(), generateBody(), HtmlGenerator::generateCollectionNode(), HtmlGenerator::generateCppReferencePage(), WebXMLGenerator::generateCppReferencePage(), WebXMLGenerator::generateExampleFilePage(), HtmlGenerator::generateGenericCollectionPage(), HtmlGenerator::generatePageNode(), WebXMLGenerator::generatePageNode(), HtmlGenerator::generateProxyPage(), HtmlGenerator::generateQmlTypePage(), and outFileName().

Here is the caller graph for this function:

◆ outFileName()

QString Generator::outFileName ( )

protected

Definition at line 1964 of file generator.cpp.

References out().

Here is the call graph for this function:

◆ outputDir()

const QString & Generator::outputDir ( )

inlinestatic

Definition at line 74 of file generator.h.

◆ outputFileNames()

const QStringList & Generator::outputFileNames ( )

inlinestatic

Definition at line 77 of file generator.h.

◆ outputPrefix()

QString Generator::outputPrefix ( const Node * node )

staticprotected

Definition at line 1969 of file generator.cpp.

References Node< _Tp >::genus(), Node< _Tp >::isCollectionNode(), and Node< _Tp >::isPageNode().

Here is the call graph for this function:

◆ outputSubdir()

const QString & Generator::outputSubdir ( )

inlinestatic

Definition at line 75 of file generator.h.

◆ outputSuffix()

QString Generator::outputSuffix ( const Node * node )

staticprotected

Definition at line 1985 of file generator.cpp.

References Node< _Tp >::genus(), and Node< _Tp >::isPageNode().

Here is the call graph for this function:

◆ parseArg()

bool Generator::parseArg	(	const QString &	src,
		const QString &	tag,
		int *	pos,
		int	n,
		QStringView *	contents,
		QStringView *	par1 = nullptr )

protected

Definition at line 2001 of file generator.cpp.

◆ plainCode()

QString Generator::plainCode ( const QString & markedCode )

static

Definition at line 2077 of file generator.cpp.

◆ qmlTypeContext()

QmlTypeNode * Generator::qmlTypeContext ( )

inlinestatic

Definition at line 84 of file generator.h.

◆ registeredStringsCount()

qsizetype Generator::registeredStringsCount ( )

inline

Definition at line 24 of file generator.h.

◆ resetUseOutputSubdirs()

void Generator::resetUseOutputSubdirs ( )

inlinestatic

Definition at line 81 of file generator.h.

Referenced by initializeFormat().

Here is the caller graph for this function:

◆ setQmlTypeContext()

void Generator::setQmlTypeContext ( QmlTypeNode * t )

inlinestatic

Definition at line 83 of file generator.h.

Referenced by DocBookGenerator::generateQmlTypePage(), and HtmlGenerator::generateQmlTypePage().

Here is the caller graph for this function:

◆ signatureList()

void Generator::signatureList	(	const QList< Node * > &	nodes,
		const Node *	relative,
		CodeMarker *	marker )

protected

Generate a bullet list of function signatures.

The function nodes are in nodes. It uses the relative node and the marker for the generation.

Definition at line 129 of file generator.cpp.

References generateText(), Atom::ListLeft, and Atom::ListRight.

Here is the call graph for this function:

◆ skipAtoms()

int Generator::skipAtoms	(	const Atom *	atom,
		Atom::AtomType	type ) const

protectedvirtual

Definition at line 2088 of file generator.cpp.

References Atom::next(), and Atom::type().

Referenced by DocBookGenerator::generateAtom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ snippets_4_to_11() [1/2]

qreal Generator::snippets_4_to_11	(	int	z,
		quint32 *	begin,
		quint32 *	end,
		const quint32 *	seedBuffer,
		size_t	len )

[4]

[5]

[6]

[7]

[8]

[9]

[10]

[11]

Definition at line 38 of file src_corelib_global_qrandom.cpp.

◆ snippets_4_to_11() [2/2]

qreal Generator::snippets_4_to_11	(	int	z,
		quint32 *	begin,
		quint32 *	end,
		const quint32 *	seedBuffer,
		size_t	len )

◆ sortOrder()

Qt::SortOrder Generator::sortOrder ( const QString & str )

inlinestatic

Definition at line 183 of file generator.h.

◆ supplementAlsoList()

void Generator::supplementAlsoList	(	const Node *	node,
		QList< Text > &	alsoList )

staticprotected

Definition at line 2114 of file generator.cpp.

References Node< _Tp >::access(), Atom::FormattingLeft, Atom::FormattingRight, FunctionNode::isDeprecated(), Node< _Tp >::isFunction(), Node< _Tp >::isMacro(), Atom::Link, FunctionNode::overloadNumber(), Node< _Tp >::parent(), and Private.

Here is the call graph for this function:

◆ terminate()

void Generator::terminate ( )

static

Definition at line 2197 of file generator.cpp.

Referenced by processQdocconfFile().

Here is the caller graph for this function:

◆ terminateGenerator()

void Generator::terminateGenerator ( )

virtual

Reimplemented in HtmlGenerator, and WebXMLGenerator.

Definition at line 2234 of file generator.cpp.

Referenced by HtmlGenerator::terminateGenerator().

Here is the caller graph for this function:

◆ trimmedTrailing()

QString Generator::trimmedTrailing	(	const QString &	string,
		const QString &	prefix,
		const QString &	suffix )

staticprotected

Trims trailing whitespace off the string and returns the trimmed string.

Definition at line 2240 of file generator.cpp.

◆ typeString()

QString Generator::typeString ( const Node * node )

virtual

Definition at line 2252 of file generator.cpp.

References Class, Enum, Function, FunctionNode::MacroWithoutParams, FunctionNode::MacroWithParams, FunctionNode::metaness(), Module, Namespace, Node< _Tp >::nodeType(), Page, Property, FunctionNode::QmlMethod, QmlModule, QmlProperty, FunctionNode::QmlSignal, FunctionNode::QmlSignalHandler, QmlType, QmlValueType, SharedComment, Struct, TypeAlias, Typedef, and Union.

Here is the call graph for this function:

◆ unknownAtom()

void Generator::unknownAtom ( const Atom * atom )

protected

Definition at line 2305 of file generator.cpp.

Referenced by DocBookGenerator::generateAtom(), and HtmlGenerator::generateAtom().

Here is the caller graph for this function:

◆ useOutputSubdirs()

bool Generator::useOutputSubdirs ( )

inlinestatic

Definition at line 82 of file generator.h.

Referenced by initializeFormat().

Here is the caller graph for this function:

Member Data Documentation

◆ file_resolver

FileResolver& Generator::file_resolver

protected

Definition at line 215 of file generator.h.

Referenced by Generator(), WebXMLGenerator::addAtomElements(), DocBookGenerator::generateAtom(), and HtmlGenerator::generateAtom().

◆ m_inContents

bool Generator::m_inContents { false }

protected

Definition at line 219 of file generator.h.

Referenced by DocBookGenerator::generateAtom(), HtmlGenerator::generateAtom(), and initializeTextOutput().

◆ m_inLink

bool Generator::m_inLink { false }

protected

Definition at line 218 of file generator.h.

Referenced by WebXMLGenerator::addAtomElements(), WebXMLGenerator::append(), DocBookGenerator::generateAtom(), HtmlGenerator::generateAtom(), and initializeTextOutput().

◆ m_inSectionHeading

bool Generator::m_inSectionHeading { false }

protected

Definition at line 220 of file generator.h.

Referenced by WebXMLGenerator::addAtomElements(), WebXMLGenerator::append(), DocBookGenerator::generateAtom(), HtmlGenerator::generateAtom(), and initializeTextOutput().

◆ m_inTableHeader

bool Generator::m_inTableHeader { false }

protected

Definition at line 221 of file generator.h.

Referenced by DocBookGenerator::generateAtom(), HtmlGenerator::generateAtom(), and initializeTextOutput().

◆ m_link

QString Generator::m_link {}

protected

Definition at line 225 of file generator.h.

◆ m_numTableRows

int Generator::m_numTableRows { 0 }

protected

Definition at line 224 of file generator.h.

Referenced by HtmlGenerator::generateAtom(), and initializeTextOutput().

◆ m_qdb

QDocDatabase* Generator::m_qdb { nullptr }

protected

Definition at line 217 of file generator.h.

Referenced by WebXMLGenerator::addAtomElements(), DocBookGenerator::generateAtom(), HtmlGenerator::generateAtom(), DocBookGenerator::generateDocBookSynopsis(), generateDocs(), DocBookGenerator::generateDocumentation(), generateDocumentation(), WebXMLGenerator::generateDocumentation(), DocBookGenerator::generateGroupReferenceText(), DocBookGenerator::generateHeader(), DocBookGenerator::generateList(), and DocBookGenerator::generateRequisites().

◆ m_quoting

bool Generator::m_quoting { false }

protected

Definition at line 223 of file generator.h.

Referenced by WebXMLGenerator::addAtomElements(), and initializeFormat().

◆ m_sectionNumber

QString Generator::m_sectionNumber {}

protected

Definition at line 226 of file generator.h.

◆ m_threeColumnEnumValueTable

bool Generator::m_threeColumnEnumValueTable { true }

protected

Definition at line 222 of file generator.h.

Referenced by DocBookGenerator::generateAtom(), HtmlGenerator::generateAtom(), and initializeTextOutput().

◆ naturalLanguage

QString Generator::naturalLanguage

protected

Definition at line 159 of file generator.h.

◆ outStreamStack

QStack<QTextStream *> Generator::outStreamStack

protected

Definition at line 161 of file generator.h.

◆ tagFile_

QString Generator::tagFile_

protected

Definition at line 160 of file generator.h.

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

qtbase/src/corelib/doc/snippets/code/src_corelib_global_qrandom.cpp (55dc3ddaa7523a3e470c98271ea55fc7d2f3c414)
qtbase/src/tools/moc/generator.h (41bbe3cbf091406cdd8f8ac4fcb1d0e19b7b4548)
qttools/src/qdoc/qdoc/src/qdoc/generator.h (86af659da25fd728826c9ed1473ad223d5dbe8d0)
qtbase/src/tools/moc/generator.cpp (b67a670801d9e0e0ff729289a528d859bf914a0f)
qttools/src/qdoc/qdoc/src/qdoc/generator.cpp (4a5b7c952cce35ba80995f9a34566626ec6e8460)

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Addendum

◆ AdmonitionPrefix

◆ ListType

Constructor & Destructor Documentation

◆ Generator() [1/2]

◆ Generator() [2/2]

◆ ~Generator()

Member Function Documentation

◆ addImageToCopy()

◆ addNodeLink() [1/2]

◆ addNodeLink() [2/2]

◆ appendFullName() [1/2]

◆ appendFullName() [2/2]

◆ appendSignature()

◆ appendSortedNames()

◆ appendSortedQmlNames()

◆ appendTrademark()

◆ autolinkErrors()

◆ beginSubPage()

◆ canHandleFormat()

◆ cleanRef()

◆ cmakeRequisite()

◆ comparePaths()

◆ currentGenerator()

◆ defaultModuleName()

◆ endSubPage()

◆ exampleFileTitle()

◆ fileBase()

◆ fileExtension()

◆ fileName()

◆ format()

◆ formatSince()

◆ formattingLeftMap()

◆ formattingRightMap()

◆ fullDocumentLocation()

◆ generateAddendum() [1/2]

◆ generateAddendum() [2/2]

◆ generateAlsoList() [1/2]

◆ generateAlsoList() [2/2]

◆ generateAtom()

◆ generateAtomList()

◆ generateBody()

◆ generateCode()

◆ generateCollectionNode()

◆ generateComparisonCategory()

◆ generateComparisonList()

◆ generateCppReferencePage()

◆ generateDocs()

◆ generateDocumentation()

◆ generateEnumValuesForQmlReference()

◆ generateExampleFilePage()

◆ generateFileList()

◆ generateGenericCollectionPage()

◆ generateLinkToExample()

◆ generateNoexceptNote()

◆ generateObjectName()

◆ generateOverloadSnippet()

◆ generatePageNode()

◆ generateProxyPage()

◆ generateQmlTypePage()

◆ generateRequiredLinks()

◆ generateSince()

◆ generateStatus()

◆ generateText() [1/2]

◆ generateText() [2/2]

◆ generateThreadSafeness()

◆ generatorForFormat()

◆ hasExceptions()

◆ indent()

◆ initialize()

◆ initializeFormat()