#include <aggregate.h>

Inheritance diagram for Aggregate:

Collaboration diagram for Aggregate:

Public Types
using	FunctionMap = QMap<QString, std::vector<FunctionNode*>>

Public Types inherited from Node< _Tp >
enum	NodeType : unsigned char { NoType , Namespace , Class , Struct , Union , HeaderFile , Page , Enum , Example , ExternalPage , Function , Typedef , TypeAlias , Property , Variable , Group , Module , QmlType , QmlModule , QmlProperty , QmlValueType , SharedComment , Collection , Proxy }
	An unsigned char value that identifies an object as a particular subclass of Node. More...

enum	Genus : unsigned char { DontCare = 0x0 , CPP = 0x1 , QML = 0x4 , DOC = 0x8 , API = CPP \| QML }
	An unsigned char value that specifies whether the Node represents a C++ element, a QML element, or a text document. More...

enum	Status : unsigned char { Deprecated , Preliminary , Active , Internal , DontDocument }
	An unsigned char that specifies the status of the documentation element in the documentation set. More...

enum	ThreadSafeness : unsigned char { UnspecifiedSafeness , NonReentrant , Reentrant , ThreadSafe }
	An unsigned char that specifies the degree of thread-safeness of the element. More...

enum	SignatureOption : unsigned char { SignaturePlain = 0x0 , SignatureDefaultValues = 0x1 , SignatureReturnType = 0x2 , SignatureTemplateParams = 0x4 }

enum	LinkType : unsigned char { StartLink , NextLink , PreviousLink , ContentsLink }
	An unsigned char value that probably should be moved out of the Node base class. More...

enum	FlagValue { FlagValueDefault = -1 , FlagValueFalse = 0 , FlagValueTrue = 1 }
	A value used in PropertyNode and QmlPropertyNode that can be -1, 0, or +1. More...

typedef std::set< Node< _Tp > >	Repository

typedef Repository::iterator	iterator

typedef std::list< iterator >::iterator	edge_iterator

Public Member Functions
Node *	findChildNode (const QString &name, Node::Genus genus, int findFlags=0) const
	If genus is {Node::DontCare}, find the first node in this node's child list that has the given name.

Node *	findNonfunctionChild (const QString &name, bool(Node::*)() const)
	This function searches for a child node of this Aggregate, such that the child node has the spacified name and the function isMatch returns true for the node.

void	findChildren (const QString &name, NodeVector &nodes) const
	Find all the child nodes of this node that are named name and return them in nodes.

FunctionNode *	findFunctionChild (const QString &name, const Parameters &parameters)
	Find a function node that is a child of this node, such that the function node has the specified name and parameters.

FunctionNode *	findFunctionChild (const FunctionNode *clone)
	Returns the function node that is a child of this node, such that the function described has the same name and signature as the function described by the function node clone.

void	resolveRelates ()
	Adopts each non-aggregate C++ node (function/macro, typedef, enum, variable, or a shared comment node with genus Node::CPP) to the aggregate specified in the node's documentation using the \relates command.

void	normalizeOverloads ()
	Sorts the lists of overloads in the function map and assigns overload numbers.

void	markUndocumentedChildrenInternal ()
	Mark all child nodes that have no documentation as having private access and internal status.

bool	isAggregate () const override
	Returns `true` because this node is an instance of Aggregate, which means it can have children.

const EnumNode *	findEnumNodeForValue (const QString &enumValue) const
	Finds the enum type node that has enumValue as one of its enum values and returns a pointer to it.

qsizetype	count () const
	Returns the number of children in the child list.

const NodeList &	childNodes () const
	Returns a const reference to the child list.

const NodeList &	nonfunctionList ()
	Returns a const reference to the list of child nodes of this aggregate that are not function nodes.

NodeList::ConstIterator	constBegin () const
	Returns a const iterator pointing at the beginning of the child list.

NodeList::ConstIterator	constEnd () const
	Returns a const iterator pointing at the end of the child list.

void	setIncludeFile (const QString &include)

const std::optional< QString > &	includeFile () const

QmlPropertyNode *	hasQmlProperty (const QString &) const
	If this node has a child that is a QML property named n, return a pointer to that child.

QmlPropertyNode *	hasQmlProperty (const QString &, bool attached) const
	If this node has a child that is a QML property named n and that also matches attached, return a pointer to that child.

virtual QmlTypeNode *	qmlBaseNode () const
	If this Aggregate is a QmlTypeNode, this function returns a pointer to the QmlTypeNode that is its base type.

void	addChildByTitle (Node *child, const QString &title)
	Adds the child to this node's child map using title as the key.

void	addChild (Node *child)
	Adds the child to this node's child list and sets the child's parent pointer to this Aggregate.

void	adoptChild (Node *child)
	This Aggregate becomes the adoptive parent of child.

FunctionMap &	functionMap ()
	Returns a reference to this Aggregate's function map, which is a map of all the children of this Aggregate that are FunctionNodes.

void	findAllFunctions (NodeMapMap &functionIndex)
	Insert all functions declared in this aggregate into the functionIndex.

void	findAllNamespaces (NodeMultiMap &namespaces)
	For each child of this node, if the child is a namespace node, insert the child into the namespaces multimap.

void	findAllAttributions (NodeMultiMap &attributions)
	Find all the attribution pages in this node and insert them into attributions.

bool	hasObsoleteMembers () const
	Returns true if this aggregate contains at least one child that is marked obsolete.

void	findAllObsoleteThings ()
	Finds all the obsolete C++ classes and QML types in this aggregate and all the C++ classes and QML types with obsolete members, and inserts them into maps used elsewhere for generating documentation.

void	findAllClasses ()
	Finds all the C++ classes, QML types, QML basic types, and examples in this aggregate and inserts them into appropriate maps for later use in generating documentation.

void	findAllSince ()
	Finds all the nodes in this node where a {since} command appeared in the qdoc comment and sorts them into maps according to the kind of node.

void	resolveQmlInheritance ()
	Resolves the inheritance information for all QML type children of this aggregate.

bool	hasOverloads (const FunctionNode *fn) const
	Returns `true` if this aggregate has multiple function overloads matching the name of fn.

void	appendToRelatedByProxy (const NodeList &t)
	Appends the list of node pointers to the list of elements that are related to this Aggregate but are documented in a different module.

NodeList &	relatedByProxy ()
	Returns a reference to a list of node pointers where each element points to a node in an index file for some other module, such that whatever the node represents was documented in that other module, but it is related to this Aggregate, so when the documentation for this Aggregate is written, it will contain links to elements in the other module.

QString	typeWord (bool cap) const
	Returns a word representing the kind of Aggregate this node is.

Public Member Functions inherited from PageNode
	PageNode (Aggregate *parent, const QString &name)
	This constructor sets the PageNode's parent and the name is the argument of the `{\page}` command.

	PageNode (NodeType type, Aggregate *parent, const QString &name)
	This constructor is not called directly.

bool	isPageNode () const override
	Always returns `true` because this is a PageNode.

bool	isTextPageNode () const override
	Returns `true` if this instance of PageNode is not an Aggregate.

QString	title () const override
	Returns the node's title, which is used for the page title.

QString	subtitle () const override
	Returns the node's subtitle, which may be empty.

QString	fullTitle () const override
	Returns the node's full title.

bool	setTitle (const QString &title) override
	Sets the node's title, which is used for the page title.

bool	setSubtitle (const QString &subtitle) override
	Sets the node's subtitle.

virtual QString	imageFileName () const
	If this PageNode is an ExampleNode, the image file name data member is returned.

virtual void	setImageFileName (const QString &)
	If this PageNode is an ExampleNode, the image file name data member is set to ifn.

bool	noAutoList () const
	Returns the value of the no auto-list flag.

void	setNoAutoList (bool b)
	Sets the no auto-list flag to b.

const QStringList &	groupNames () const
	Returns a const reference to the string list containing all the group names.

void	appendGroupName (const QString &t) override
	Appends t to the list of group names.

const PageNode *	navigationParent () const

void	setNavigationParent (const PageNode *parent)

void	markAttribution ()

bool	isAttribution () const

Public Member Functions inherited from Node< _Tp >
std::pair< edge_iterator, bool >	insertEdge (iterator other) const

edge_iterator	begin () const

edge_iterator	end () const

bool	operator== (const Node< _Tp > &other) const

bool	operator!= (const Node< _Tp > &other) const

bool	operator< (const Node< _Tp > &other) const

virtual	~Node ()=default
	The default destructor is virtual so any subclass of Node can be deleted by deleting a pointer to Node.

virtual Node *	clone (Aggregate *)
	When reimplemented in a subclass, this function creates a clone of this node on the heap and makes the clone a child of parent.

virtual Tree *	tree () const
	Returns a pointer to the Tree this node is in.

Aggregate *	root () const

NodeType	nodeType () const
	Returns this node's type.

QString	nodeTypeString () const
	Returns this node's type as a string for use as an attribute value in XML or HTML.

Genus	genus () const
	Returns this node's Genus.

void	setGenus (Genus t)

bool	isActive () const
	Returns true if this node's status is `Active`.

bool	isClass () const
	Returns true if the node type is `Class`.

bool	isCppNode () const
	Returns true if this node's Genus value is `CPP`.

bool	isDontDocument () const
	Returns true if this node's status is `DontDocument`.

bool	isEnumType () const
	Returns true if the node type is `Enum`.

bool	isExample () const
	Returns true if the node type is `Example`.

bool	isExternalPage () const
	Returns true if the node type is `ExternalPage`.

bool	isFunction (Genus g=DontCare) const
	Returns true if this is a FunctionNode and its Genus is set to g.

bool	isGroup () const
	Returns true if the node type is `Group`.

bool	isHeader () const
	Returns true if the node type is `HeaderFile`.

bool	isIndexNode () const
	Returns true if this node was created from something in an index file.

bool	isModule () const
	Returns true if the node type is `Module`.

bool	isNamespace () const
	Returns true if the node type is `Namespace`.

bool	isPage () const
	Returns true if the node type is `Page`.

bool	isPreliminary () const
	Returns true if this node's status is `Preliminary`.

bool	isPrivate () const
	Returns true if this node's access is `Private`.

bool	isProperty () const
	Returns true if the node type is `Property`.

bool	isProxyNode () const
	Returns true if the node type is `Proxy`.

bool	isPublic () const
	Returns true if this node's access is `Public`.

bool	isProtected () const
	Returns true if this node's access is `Protected`.

bool	isQmlBasicType () const
	Returns true if the node type is `QmlBasicType`.

bool	isQmlModule () const
	Returns true if the node type is `QmlModule`.

bool	isQmlNode () const
	Returns true if this node's Genus value is `QML`.

bool	isQmlProperty () const
	Returns true if the node type is `QmlProperty`.

bool	isQmlType () const
	Returns true if the node type is `QmlType` or `QmlValueType`.

bool	isRelatedNonmember () const
	Returns true if this is a related nonmember of something.

bool	isStruct () const
	Returns true if the node type is `Struct`.

bool	isSharedCommentNode () const
	Returns true if the node type is `SharedComment`.

bool	isTypeAlias () const
	Returns true if the node type is `Typedef`.

bool	isTypedef () const
	Returns true if the node type is `Typedef`.

bool	isUnion () const
	Returns true if the node type is `Union`.

bool	isVariable () const
	Returns true if the node type is `Variable`.

bool	isGenericCollection () const
	Returns true if the node type is `Collection`.

virtual bool	isDeprecated () const
	Returns true if this node's status is `Deprecated`.

virtual bool	isAbstract () const
	Returns true if the ClassNode or QmlTypeNode is marked abstract.

virtual bool	isFirstClassAggregate () const
	Returns true if this Node is an Aggregate but not a ProxyNode.

virtual bool	isAlias () const
	Returns true if this QML property is marked as an alias.

virtual bool	isAttached () const
	Returns true if the QML property or QML method node is marked as attached.

virtual bool	isClassNode () const
	Returns true if this is an instance of ClassNode.

virtual bool	isCollectionNode () const
	Returns true if this is an instance of CollectionNode.

virtual bool	isDefault () const
	Returns true if the QML property node is marked as default.

virtual bool	isInternal () const
	Returns `true` if the node's status is `Internal`, or if its parent is a class with `Internal` status.

virtual bool	isMacro () const
	returns true if either FunctionNode::isMacroWithParams() or FunctionNode::isMacroWithoutParams() returns true.

virtual bool	isRelatableType () const
	Returns true if this node is something you can relate things to with the relates command.

virtual bool	isMarkedReimp () const
	Returns true if the FunctionNode is marked as a reimplemented function.

virtual bool	isPropertyGroup () const
	Returns true if the node is a SharedCommentNode for documenting multiple C++ properties or multiple QML properties.

virtual bool	isStatic () const
	Returns true if the FunctionNode represents a static function.

virtual bool	isWrapper () const
	Returns `true` if the node is a class node or a QML type node that is marked as being a wrapper class or wrapper QML type, or if it is a member of a wrapper class or type.

QString	plainName () const
	Returns this node's name member.

QString	plainFullName (const Node *relative=nullptr) const
	Constructs and returns the node's fully qualified name by recursively ascending the parent links and prepending each parent name + "::".

QString	plainSignature () const
	Constructs and returns the node's fully qualified signature by recursively ascending the parent links and prepending each parent name + "::" to the plain signature.

QString	fullName (const Node *relative=nullptr) const
	Constructs and returns this node's full name.

virtual QString	signature (Node::SignatureOptions) const
	void Node::setGenus(Genus t) Sets this node's Genus to t.

const QString &	fileNameBase () const
	Returns the node's file name base string, which is built once, when Generator::fileBase() is called and stored in the Node.

bool	hasFileNameBase () const
	Returns true if the node's file name base has been set.

void	setFileNameBase (const QString &t)
	Sets the node's file name base to t.

void	setAccess (Access t)
	Sets the node's access type to t.

void	setLocation (const Location &t)
	Sets the node's declaration location, its definition location, or both, depending on the suffix of the file name from the file path in location t.

void	setDoc (const Doc &doc, bool replace=false)
	Sets this Node's Doc to doc.

void	setStatus (Status t)
	Sets the node's status to t.

void	setThreadSafeness (ThreadSafeness t)
	Sets the node's thread safeness to t.

void	setSince (const QString &since)
	Sets the information about the project and version a node was introduced in, unless the version is lower than the 'ignoresince.

void	setPhysicalModuleName (const QString &name)
	Sets the node's physical module name.

void	setUrl (const QString &url)
	Sets the node's URL to url, which is the url to the page that the node represents.

void	setTemplateDecl (std::optional< RelaxedTemplateDeclaration > t)

void	setReconstitutedBrief (const QString &t)
	When reading an index file, this function is called with the reconstituted brief clause t to set the node's brief clause.

void	setParent (Aggregate *n)
	Sets the node's parent pointer to n.

void	setIndexNodeFlag (bool isIndexNode=true)
	Sets a flag in this Node that indicates the node was created for something in an index file.

void	setHadDoc ()

void	setComparisonCategory (const ComparisonCategory &category)

ComparisonCategory	comparisonCategory () const

virtual void	setRelatedNonmember (bool b)
	Sets a flag in the node indicating whether this node is a related nonmember of something.

virtual void	addMember (Node *)
	In a CollectionNode, this function adds node to the collection node's members list.

virtual bool	hasNamespaces () const
	Returns `true` if this is a CollectionNode and its members list contains namespace nodes.

virtual bool	hasClasses () const
	Returns `true` if this is a CollectionNode and its members list contains class nodes.

virtual void	setAbstract (bool)
	If this node is a ClassNode or a QmlTypeNode, the node's abstract flag data member is set to b.

virtual void	setWrapper ()
	If this node is a ClassNode or a QmlTypeNode, the node's wrapper flag data member is set to `true`.

virtual void	setDataType (const QString &)
	If this node is a PropertyNode or a QmlPropertyNode, its data type data member is set to dataType.

virtual bool	wasSeen () const
	Returns the `seen` flag data member of this node if it is a NamespaceNode or a CollectionNode.

virtual QString	element () const
	If this node is a QmlPropertyNode or a FunctionNode, this function returns the name of the parent node.

virtual bool	docMustBeGenerated () const
	This function is called to perform a test to decide if the node must have documentation generated.

void	markInternal ()
	Sets the node's access to Private and its status to Internal.

virtual void	markDefault ()
	If this node is a QmlPropertyNode, it is marked as the default property.

virtual void	markReadOnly (bool)
	If this node is a QmlPropertyNode, then the property's read-only flag is set to flag.

Aggregate *	parent () const
	Returns the node's parent pointer.

const QString &	name () const
	Returns the node's name data member.

QString	physicalModuleName () const

QString	url () const
	Returns the node's URL, which is the url of the documentation page created for the node or the url of an external page if the node is an ExternalPageNode.

virtual void	setQtVariable (const QString &)
	If this node is a CollectionNode, its QT variable is set to v.

virtual QString	qtVariable () const
	If this node is a CollectionNode, its QT variable is returned.

virtual void	setCMakePackage (const QString &)

virtual void	setCMakeComponent (const QString &)

virtual void	setCMakeTargetItem (const QString &)

virtual QString	cmakePackage () const

virtual QString	cmakeComponent () const

virtual QString	cmakeTargetItem () const

virtual bool	hasTag (const QString &) const
	If this node is a FunctionNode, the function returns `true` if the function has the tag t.

void	setDeprecated (const QString &sinceVersion)
	Sets the Node status to Node::Deprecated, unless sinceVersion represents a future version.

const QString &	deprecatedSince () const

const QMap< LinkType, std::pair< QString, QString > > &	links () const
	Returns a reference to this node's link map.

void	setLink (LinkType linkType, const QString &link, const QString &desc)
	This function creates a pair that describes a link.

Access	access () const
	Returns the node's Access setting, which can be `Public`, `Protected`, or `Private`.

const Location &	declLocation () const
	Returns the Location where this node's declaration was seen.

const Location &	defLocation () const
	Returns the Location where this node's dedefinition was seen.

const Location &	location () const
	If this node's definition location is empty, this function returns this node's declaration location.

const Doc &	doc () const
	Returns a reference to the node's Doc data member.

bool	isInAPI () const

bool	hasDoc () const
	Returns `true` if this node is documented, or it represents a documented node read from the index ('had doc'), or this node is sharing a non-empty doc with other nodes.

bool	hadDoc () const

Status	status () const
	Returns the node's status value.

ThreadSafeness	threadSafeness () const
	Returns the thread safeness value for whatever this node represents.

ThreadSafeness	inheritedThreadSafeness () const
	If this node has a parent, the parent's thread safeness value is returned.

QString	since () const
	Returns the node's since string, which can be empty.

const std::optional< RelaxedTemplateDeclaration > &	templateDecl () const

const QString &	reconstitutedBrief () const

bool	isSharingComment () const
	This function returns `true` if the node is sharing a comment with other nodes.

void	setSharedCommentNode (SharedCommentNode *t)

SharedCommentNode *	sharedCommentNode ()

QString	extractClassName (const QString &string) const
	Extract a class name from the type string and return it.

virtual QString	qmlTypeName () const
	If this is a QmlPropertyNode or a FunctionNode representing a QML method, this function returns the qmlTypeName() of the parent() node.

virtual QString	qmlFullBaseName () const
	If this is a QmlTypeNode, this function returns the QML full base name.

virtual QString	logicalModuleName () const
	If this is a CollectionNode, this function returns the logical module name.

virtual QString	logicalModuleVersion () const
	If this is a CollectionNode, this function returns the logical module version number.

virtual QString	logicalModuleIdentifier () const
	If this is a CollectionNode, this function returns the logical module identifier.

virtual void	setLogicalModuleInfo (const QStringList &)
	If this node is a CollectionNode, this function splits arg on the blank character to get a logical module name and version number.

virtual CollectionNode *	logicalModule () const
	If this is a QmlTypeNode, a pointer to its QML module is returned, which is a pointer to a CollectionNode.

virtual void	setQmlModule (CollectionNode *)
	If this is a QmlTypeNode, this function sets the QML type's QML module pointer to the CollectionNode t.

virtual ClassNode *	classNode ()
	If this is a QmlTypeNode, this function returns the pointer to the C++ ClassNode that this QML type represents.

virtual void	setClassNode (ClassNode *)
	If this is a QmlTypeNode, this function sets the C++ class node to cn.

QString	fullDocumentName () const
	Construct the full document name for this node and return it.

QString	qualifyCppName ()
	Returns the CPP node's qualified name by prepending the namespaces name + "::" if there isw a namespace.

QString	qualifyQmlName ()
	Returns the QML node's qualified name by prepending the logical module name.

QString	qualifyWithParentName ()
	Return the name of this node qualified with the parent name and "::" if there is a parent name.

Protected Member Functions
	Aggregate (NodeType type, Aggregate *parent, const QString &name)
	The constructor should never be called directly.

	~Aggregate () override
	Destroys this Aggregate; deletes each child.

Protected Member Functions inherited from Node< _Tp >
	Node ()

	Node (_Tp d)

	Node (NodeType type, Aggregate *parent, QString name)
	Construct a node with the given type and having the given parent and name.

Protected Attributes
NodeList	m_children {}

NodeList	m_relatedByProxy {}

FunctionMap	m_functionMap {}

Protected Attributes inherited from PageNode
bool	m_noAutoList { false }

QString	m_title {}

QString	m_subtitle {}

QStringList	m_groupNames {}

bool	is_attribution { false }

Friends
class	Node

Additional Inherited Members
Static Public Member Functions inherited from Node< _Tp >
static iterator	get (_Tp data)

static iterator	begin_nodes ()

static iterator	end_nodes ()

static Repository &	repository ()

static Genus	getGenus (NodeType t)
	Determines the appropriate Genus value for the NodeType value t and returns that Genus value.

static FlagValue	toFlagValue (bool b)
	Converts the boolean value b to an enum representation of the boolean type, which includes an enum value for the {default value} of the item, i.e.

static bool	fromFlagValue (FlagValue fv, bool defaultValue)
	Converts the enum fv back to a boolean value.

static QString	nodeTypeString (NodeType t)
	Returns the node type t as a string for use as an attribute value in XML or HTML.

static bool	nodeNameLessThan (const Node first, const Node second)
	Returns `true` if the node n1 is less than node n2.

static bool	nodeSortKeyOrNameLessThan (const Node n1, const Node n2)
	Returns `true` if node n1 is less than node n2 when comparing the sort keys, defined with.

Public Attributes inherited from Node< _Tp >
bool	root
	Returns a pointer to the root of the Tree this node is in.

int	dfn

_Tp	data

std::list< iterator >	outs

Detailed Description

Definition at line 21 of file aggregate.h.

Member Typedef Documentation

◆ FunctionMap

using Aggregate::FunctionMap = QMap<QString, std::vector<FunctionNode*>>

Definition at line 24 of file aggregate.h.

Constructor & Destructor Documentation

◆ Aggregate()

Aggregate::Aggregate	(	NodeType	type,
		Aggregate *	parent,
		const QString &	name )

inlineprotected

The constructor should never be called directly.

It is only called by the constructors of subclasses of Aggregate. Those constructors pass the node type they want to create, the parent of the new node, and its name.

Definition at line 74 of file aggregate.h.

◆ ~Aggregate()

Aggregate::~Aggregate ( )

overrideprotected

Destroys this Aggregate; deletes each child.

Definition at line 51 of file aggregate.cpp.

References m_children.

Member Function Documentation

◆ addChild()

void Aggregate::addChild ( Node * child )

Adds the child to this node's child list and sets the child's parent pointer to this Aggregate.

It then mounts the child with mountChild().

The child is then added to this Aggregate's searchable maps and lists.

Note: This function does not test the child's parent pointer for null before changing it. If the child's parent pointer is not null, then it is being reparented. The child becomes a child of this Aggregate, but it also remains a child of the Aggregate that is it's old parent. But the child will only have one parent, and it will be this Aggregate. The is because of the relates command.

See also: mountChild(), dismountChild()

Definition at line 364 of file aggregate.cpp.

References Node< _Tp >::isEnumType(), Node< _Tp >::isFunction(), Node< _Tp >::isIndexNode(), m_children, Node< _Tp >::setIndexNodeFlag(), and Node< _Tp >::setParent().

Referenced by Node< _Tp >::Node(), EnumNode::clone(), SharedCommentNode::clone(), TypeAliasNode::clone(), TypedefNode::clone(), and VariableNode::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addChildByTitle()

void Aggregate::addChildByTitle	(	Node *	child,
		const QString &	title )

Adds the child to this node's child map using title as the key.

The child is not added to the child list again, because it is presumed to already be there. We just want to be able to find the child by its title.

Definition at line 341 of file aggregate.cpp.

◆ adoptChild()

void Aggregate::adoptChild ( Node * child )

This Aggregate becomes the adoptive parent of child.

The child knows this Aggregate as its parent, but its former parent continues to have pointers to the child in its child list and in its searchable data structures. But the child is also added to the child list and searchable data structures of this Aggregate.

Definition at line 388 of file aggregate.cpp.

References Node< _Tp >::isEnumType(), Node< _Tp >::isFunction(), Node< _Tp >::isSharedCommentNode(), m_children, Node< _Tp >::parent(), and Node< _Tp >::setParent().

Here is the call graph for this function:

◆ appendToRelatedByProxy()

void Aggregate::appendToRelatedByProxy ( const NodeList & t )

inline

Appends the list of node pointers to the list of elements that are related to this Aggregate but are documented in a different module.

See also: relatedByProxy()

Definition at line 69 of file aggregate.h.

References m_relatedByProxy.

◆ childNodes()

const NodeList & Aggregate::childNodes ( ) const

inlinenodiscard

Returns a const reference to the child list.

Definition at line 41 of file aggregate.h.

References m_children.

Referenced by Generator::generateDocumentation(), and Generator::hasExceptions().

Here is the caller graph for this function:

◆ constBegin()

NodeList::ConstIterator Aggregate::constBegin ( ) const

inlinenodiscard

Returns a const iterator pointing at the beginning of the child list.

Definition at line 43 of file aggregate.h.

References m_children.

◆ constEnd()

NodeList::ConstIterator Aggregate::constEnd ( ) const

inlinenodiscard

Returns a const iterator pointing at the end of the child list.

Definition at line 44 of file aggregate.h.

References m_children.

◆ count()

qsizetype Aggregate::count ( ) const

inlinenodiscard

Returns the number of children in the child list.

Definition at line 40 of file aggregate.h.

References m_children.

◆ findAllAttributions()

void Aggregate::findAllAttributions ( NodeMultiMap & attributions )

Find all the attribution pages in this node and insert them into attributions.

Definition at line 597 of file aggregate.cpp.

◆ findAllClasses()

void Aggregate::findAllClasses ( )

Finds all the C++ classes, QML types, QML basic types, and examples in this aggregate and inserts them into appropriate maps for later use in generating documentation.

Definition at line 568 of file aggregate.cpp.

◆ findAllFunctions()

void Aggregate::findAllFunctions ( NodeMapMap & functionIndex )

Insert all functions declared in this aggregate into the functionIndex.

Call the function recursively for each child that is an aggregate.

Only include functions that are in the public API and that are not constructors or destructors.

Definition at line 475 of file aggregate.cpp.

◆ findAllNamespaces()

void Aggregate::findAllNamespaces ( NodeMultiMap & namespaces )

For each child of this node, if the child is a namespace node, insert the child into the namespaces multimap.

If the child is an aggregate, call this function recursively for that child.

When the function called with the root node of a tree, it finds all the namespace nodes in that tree and inserts them into the namespaces multimap.

The root node of a tree is a namespace, but it has no name, so it is not inserted into the map. So, if this function is called for each tree in the qdoc database, it finds all the namespace nodes in the database.

Definition at line 506 of file aggregate.cpp.

Referenced by QDocDatabase::resolveNamespaces().

Here is the caller graph for this function:

◆ findAllObsoleteThings()

void Aggregate::findAllObsoleteThings ( )

Finds all the obsolete C++ classes and QML types in this aggregate and all the C++ classes and QML types with obsolete members, and inserts them into maps used elsewhere for generating documentation.

Definition at line 538 of file aggregate.cpp.

◆ findAllSince()

void Aggregate::findAllSince ( )

Finds all the nodes in this node where a {since} command appeared in the qdoc comment and sorts them into maps according to the kind of node.

This function is used for generating the "New Classes... in x.y" section on the {What's New in Qt x.y} page.

Definition at line 617 of file aggregate.cpp.

◆ findChildNode()

Node * Aggregate::findChildNode	(	const QString &	name,
		Node::Genus	genus,
		int	findFlags = 0 ) const

nodiscard

If genus is {Node::DontCare}, find the first node in this node's child list that has the given name.

If this node is a QML type, be sure to also look in the children of its property group nodes. Return the matching node or nullptr.

If genus is either {Node::CPP} or {Node::QML}, then find all this node's children that have the given name, and return the one that satisfies the genus requirement.

Definition at line 74 of file aggregate.cpp.

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

Here is the call graph for this function:

◆ findChildren()

void Aggregate::findChildren	(	const QString &	name,
		NodeVector &	nodes ) const

Find all the child nodes of this node that are named name and return them in nodes.

Definition at line 105 of file aggregate.cpp.

◆ findEnumNodeForValue()

const EnumNode * Aggregate::findEnumNodeForValue ( const QString & enumValue ) const

nodiscard

Finds the enum type node that has enumValue as one of its enum values and returns a pointer to it.

Returns 0 if no enum type node is found that has enumValue as one of its values.

Definition at line 325 of file aggregate.cpp.

◆ findFunctionChild() [1/2]

FunctionNode * Aggregate::findFunctionChild ( const FunctionNode * clone )

Returns the function node that is a child of this node, such that the function described has the same name and signature as the function described by the function node clone.

Returns \nullptr if no matching function was found.

Definition at line 179 of file aggregate.cpp.

References FunctionNode::compare.

Here is the call graph for this function:

◆ findFunctionChild() [2/2]

FunctionNode * Aggregate::findFunctionChild	(	const QString &	name,
		const Parameters &	parameters )

Find a function node that is a child of this node, such that the function node has the specified name and parameters.

If parameters is empty but no matching function is found that has no parameters, return the first non-internal primary function or overload, whether it has parameters or not.

See also: normalizeOverloads()

Definition at line 145 of file aggregate.cpp.

References Parameters::at(), Parameters::count(), Parameters::isEmpty(), Node< _Tp >::isInternal(), and FunctionNode::parameters().

Here is the call graph for this function:

◆ findNonfunctionChild()

Node * Aggregate::findNonfunctionChild	(	const QString &	name,
		bool(Node::*	isMatch )() const )

This function searches for a child node of this Aggregate, such that the child node has the spacified name and the function isMatch returns true for the node.

The function passed must be one of the isXxx() functions in class Node that tests the node type.

Definition at line 126 of file aggregate.cpp.

◆ functionMap()

FunctionMap & Aggregate::functionMap ( )

inline

Returns a reference to this Aggregate's function map, which is a map of all the children of this Aggregate that are FunctionNodes.

Definition at line 59 of file aggregate.h.

◆ hasObsoleteMembers()

bool Aggregate::hasObsoleteMembers ( ) const

nodiscard

Returns true if this aggregate contains at least one child that is marked obsolete.

Otherwise returns false.

Definition at line 521 of file aggregate.cpp.

◆ hasOverloads()

bool Aggregate::hasOverloads ( const FunctionNode * fn ) const

Returns true if this aggregate has multiple function overloads matching the name of fn.

Note: Assumes fn is a member of this aggregate.

Definition at line 446 of file aggregate.cpp.

◆ hasQmlProperty() [1/2]

QmlPropertyNode * Aggregate::hasQmlProperty ( const QString & n ) const

nodiscard

If this node has a child that is a QML property named n, return a pointer to that child.

Otherwise, return \nullptr.

Definition at line 412 of file aggregate.cpp.

References Node< _Tp >::QmlProperty.

◆ hasQmlProperty() [2/2]

QmlPropertyNode * Aggregate::hasQmlProperty	(	const QString &	n,
		bool	attached ) const

nodiscard

If this node has a child that is a QML property named n and that also matches attached, return a pointer to that child.

Definition at line 428 of file aggregate.cpp.

References Node< _Tp >::QmlProperty.

◆ includeFile()

const std::optional< QString > & Aggregate::includeFile ( ) const

inlinenodiscard

Definition at line 50 of file aggregate.h.

◆ isAggregate()

bool Aggregate::isAggregate ( ) const

inlinenodiscardoverridevirtual

Returns true because this node is an instance of Aggregate, which means it can have children.

Reimplemented from Node< _Tp >.

Definition at line 37 of file aggregate.h.

◆ markUndocumentedChildrenInternal()

void Aggregate::markUndocumentedChildrenInternal ( )

Mark all child nodes that have no documentation as having private access and internal status.

qdoc will then ignore them for documentation purposes.

Definition at line 198 of file aggregate.cpp.

Referenced by QDocDatabase::resolveStuff().

Here is the caller graph for this function:

◆ nonfunctionList()

const NodeList & Aggregate::nonfunctionList ( )

Returns a const reference to the list of child nodes of this aggregate that are not function nodes.

Duplicate nodes are removed from the list and the list is sorted.

Definition at line 301 of file aggregate.cpp.

References Node< _Tp >::nodeNameLessThan().

Here is the call graph for this function:

◆ normalizeOverloads()

void Aggregate::normalizeOverloads ( )

Sorts the lists of overloads in the function map and assigns overload numbers.

For sorting, active functions take precedence over internal ones, as well as ones marked as \overload - the latter ones typically do not contain full documentation, so selecting them as the primary function would cause unnecessary warnings to be generated.

Otherwise, the order is set as determined by FunctionNode::compare().

Definition at line 268 of file aggregate.cpp.

References FunctionNode::compare, Node< _Tp >::hasDoc(), Node< _Tp >::isInternal(), and FunctionNode::isOverload().

Referenced by QDocDatabase::resolveStuff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ qmlBaseNode()

virtual QmlTypeNode * Aggregate::qmlBaseNode ( ) const

inlinevirtual

If this Aggregate is a QmlTypeNode, this function returns a pointer to the QmlTypeNode that is its base type.

Otherwise it returns nullptr. A QmlTypeNode doesn't always have a base type, so even when this Aggregate is aQmlTypeNode, the pointer returned can be nullptr.

Reimplemented in QmlTypeNode.

Definition at line 54 of file aggregate.h.

Referenced by Sections::buildStdQmlTypeRefPageSections().

Here is the caller graph for this function:

◆ relatedByProxy()

NodeList & Aggregate::relatedByProxy ( )

inline

Returns a reference to a list of node pointers where each element points to a node in an index file for some other module, such that whatever the node represents was documented in that other module, but it is related to this Aggregate, so when the documentation for this Aggregate is written, it will contain links to elements in the other module.

Definition at line 70 of file aggregate.h.

References m_relatedByProxy.

Referenced by Sections::buildStdCppClassRefPageSections(), and Sections::buildStdRefPageSections().

Here is the caller graph for this function:

◆ resolveQmlInheritance()

void Aggregate::resolveQmlInheritance ( )

Resolves the inheritance information for all QML type children of this aggregate.

Definition at line 681 of file aggregate.cpp.

Referenced by QDocDatabase::resolveStuff().

Here is the caller graph for this function:

◆ resolveRelates()

void Aggregate::resolveRelates ( )

Adopts each non-aggregate C++ node (function/macro, typedef, enum, variable, or a shared comment node with genus Node::CPP) to the aggregate specified in the node's documentation using the \relates command.

If the target Aggregate is not found in the primary tree, creates a new ProxyNode to use as the parent.

Definition at line 228 of file aggregate.cpp.

References QDocDatabase::qdocDB().

Referenced by QDocDatabase::resolveStuff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIncludeFile()

void Aggregate::setIncludeFile ( const QString & include )

inline

Definition at line 46 of file aggregate.h.

◆ typeWord()

QString Aggregate::typeWord ( bool cap ) const

nodiscard

Returns a word representing the kind of Aggregate this node is.

Currently recognizes class, struct, union, and namespace. If cap is true, the word is capitalised.

Definition at line 696 of file aggregate.cpp.

References Node< _Tp >::nodeType().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ Node

friend class Node

friend

Definition at line 79 of file aggregate.h.

Member Data Documentation

◆ m_children

NodeList Aggregate::m_children {}

protected

Definition at line 83 of file aggregate.h.

Referenced by ~Aggregate(), addChild(), adoptChild(), childNodes(), constBegin(), constEnd(), count(), HeaderNode::hasDocumentedChildren(), and NamespaceNode::hasDocumentedChildren().

◆ m_functionMap

FunctionMap Aggregate::m_functionMap {}

protected

Definition at line 85 of file aggregate.h.

◆ m_relatedByProxy

NodeList Aggregate::m_relatedByProxy {}

protected

Definition at line 84 of file aggregate.h.

Referenced by appendToRelatedByProxy(), and relatedByProxy().

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

qttools/src/qdoc/qdoc/src/qdoc/aggregate.h (7c928c80085be39cf2354e27d8cbcee50705fcc9)
qttools/src/qdoc/qdoc/src/qdoc/aggregate.cpp (ab17fa7c43ddf34d3f763bfc0f29bba799d6f22b)

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ FunctionMap

Constructor & Destructor Documentation

◆ Aggregate()

◆ ~Aggregate()

Member Function Documentation

◆ addChild()

◆ addChildByTitle()

◆ adoptChild()

◆ appendToRelatedByProxy()

◆ childNodes()

◆ constBegin()

◆ constEnd()

◆ count()

◆ findAllAttributions()

◆ findAllClasses()

◆ findAllFunctions()

◆ findAllNamespaces()

◆ findAllObsoleteThings()

◆ findAllSince()

◆ findChildNode()

◆ findChildren()

◆ findEnumNodeForValue()

◆ findFunctionChild() [1/2]

◆ findFunctionChild() [2/2]

◆ findNonfunctionChild()

◆ functionMap()

◆ hasObsoleteMembers()

◆ hasOverloads()

◆ hasQmlProperty() [1/2]

◆ hasQmlProperty() [2/2]

◆ includeFile()

◆ isAggregate()

◆ markUndocumentedChildrenInternal()

◆ nonfunctionList()

◆ normalizeOverloads()

◆ qmlBaseNode()

◆ relatedByProxy()

◆ resolveQmlInheritance()

◆ resolveRelates()

◆ setIncludeFile()

◆ typeWord()

Friends And Related Symbol Documentation

◆ Node

Member Data Documentation

◆ m_children

◆ m_functionMap

◆ m_relatedByProxy