Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Member Functions | List of all members
NamespaceNode Class Reference

This class represents a C++ namespace. More...

#include <namespacenode.h>

+ Inheritance diagram for NamespaceNode:
+ Collaboration diagram for NamespaceNode:

Public Member Functions

 NamespaceNode (Aggregate *parent, const QString &name)
 
 ~NamespaceNode () override=default
 
Tree * tree () const override
 Returns a pointer to the Tree that contains this NamespaceNode.
 
bool isFirstClassAggregate () const override
 Returns true.
 
bool isRelatableType () const override
 Returns true.
 
bool wasSeen () const override
 Returns true if the {\namespace} command that this NamespaceNode represents has been parsed by qdoc.
 
void markSeen ()
 Sets the data member that indicates that the {\namespace} command this NamespaceNode represents has been parsed by qdoc.
 
void setTree (Tree *t)
 Sets the Tree pointer to t, which means this NamespaceNode is in the Tree t.
 
const NodeList & includedChildren () const
 Returns a const reference to the namespace node's list of included children, which contains pointers to all the child nodes of other namespace nodes that have the same name as this namespace node.
 
void includeChild (Node *child)
 This function is only called from QDocDatabase::resolveNamespaces().
 
void setWhereDocumented (const QString &t)
 Sets the camel case name of the module where this namespace is documented to the module named t.
 
bool isDocumentedHere () const
 Returns true if this namespace is to be documented in the current module.
 
bool hasDocumentedChildren () const
 Returns true if this namespace node contains at least one child that has documentation and is not private or internal.
 
void reportDocumentedChildrenInUndocumentedNamespace () const
 Report qdoc warning for each documented child in a namespace that is not documented.
 
bool docMustBeGenerated () const override
 Returns true if this namespace node is not private and contains at least one public child node with documentation.
 
void setDocNode (NamespaceNode *ns)
 Called in QDocDatabase::resolveNamespaces() to set the pointer to the NamespaceNode in which this namespace is documented.
 
NamespaceNode * docNode () const
 Returns a pointer to the NamespaceNode that represents where the namespace documentation is actually generated.
 
- Public Member Functions inherited from Aggregate
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.
 
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 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 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 QString element () const
 If this node is a QmlPropertyNode or a FunctionNode, this function returns the name of the parent node.
 
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.
 

Additional Inherited Members

- Public Types inherited from Aggregate
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
 
- 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
 
- Protected Member Functions inherited from Aggregate
 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 inherited from Aggregate
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 }
 

Detailed Description

This class represents a C++ namespace.

A namespace can be used in multiple C++ modules, so there can be a NamespaceNode for namespace Xxx in more than one Node tree.

Definition at line 16 of file namespacenode.h.

Constructor & Destructor Documentation

◆ NamespaceNode()

NamespaceNode::NamespaceNode ( Aggregate * parent,
const QString & name )
inline

Definition at line 19 of file namespacenode.h.

References Node< _Tp >::Namespace.

◆ ~NamespaceNode()

NamespaceNode::~NamespaceNode ( )
overridedefault

Member Function Documentation

◆ docMustBeGenerated()

bool NamespaceNode::docMustBeGenerated ( ) const
nodiscardoverridevirtual

Returns true if this namespace node is not private and contains at least one public child node with documentation.

Reimplemented from Node< _Tp >.

Definition at line 78 of file namespacenode.cpp.

References hasDocumentedChildren(), and Node< _Tp >::isInAPI().

+ Here is the call graph for this function:

◆ docNode()

NamespaceNode * NamespaceNode::docNode ( ) const
inlinenodiscard

Returns a pointer to the NamespaceNode that represents where the namespace documentation is actually generated.

API elements in many different modules can be included in a single namespace. That namespace is only documented in one module. The namespace is documented in the module where the {\namespace} command for the namespace appears.

See also
QDocDatabase::resolveNamespaces()

Definition at line 36 of file namespacenode.h.

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

+ Here is the caller graph for this function:

◆ hasDocumentedChildren()

bool NamespaceNode::hasDocumentedChildren ( ) const
nodiscard

Returns true if this namespace node contains at least one child that has documentation and is not private or internal.

Definition at line 42 of file namespacenode.cpp.

References Node< _Tp >::isInAPI(), and Aggregate::m_children.

Referenced by docMustBeGenerated().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ includeChild()

void NamespaceNode::includeChild ( Node * child)

This function is only called from QDocDatabase::resolveNamespaces().

See also
includedChildren(), QDocDatabase::resolveNamespaces()

Definition at line 105 of file namespacenode.cpp.

◆ includedChildren()

const NodeList & NamespaceNode::includedChildren ( ) const
nodiscard

Returns a const reference to the namespace node's list of included children, which contains pointers to all the child nodes of other namespace nodes that have the same name as this namespace node.

The list is built after the prepare phase has been run but just before the generate phase. It is buils by QDocDatabase::resolveNamespaces().

See also
QDocDatabase::resolveNamespaces()

Definition at line 95 of file namespacenode.cpp.

Referenced by Sections::buildStdRefPageSections().

+ Here is the caller graph for this function:

◆ isDocumentedHere()

bool NamespaceNode::isDocumentedHere ( ) const
nodiscard

Returns true if this namespace is to be documented in the current module.

There can be elements declared in this namespace spread over multiple modules. Those elements are documented in the modules where they are declared, but they are linked to from the namespace page in the module where the namespace itself is documented.

Definition at line 33 of file namespacenode.cpp.

Referenced by HtmlGenerator::generateCppReferencePage().

+ Here is the caller graph for this function:

◆ isFirstClassAggregate()

bool NamespaceNode::isFirstClassAggregate ( ) const
inlinenodiscardoverridevirtual

Returns true.

Reimplemented from Node< _Tp >.

Definition at line 23 of file namespacenode.h.

◆ isRelatableType()

bool NamespaceNode::isRelatableType ( ) const
inlinenodiscardoverridevirtual

Returns true.

Reimplemented from Node< _Tp >.

Definition at line 24 of file namespacenode.h.

◆ markSeen()

void NamespaceNode::markSeen ( )
inline

Sets the data member that indicates that the {\namespace} command this NamespaceNode represents has been parsed by qdoc.

Definition at line 26 of file namespacenode.h.

Referenced by CppCodeParser::processTopicCommand().

+ Here is the caller graph for this function:

◆ reportDocumentedChildrenInUndocumentedNamespace()

void NamespaceNode::reportDocumentedChildrenInUndocumentedNamespace ( ) const

Report qdoc warning for each documented child in a namespace that is not documented.

This function should only be called when the namespace is not documented.

Definition at line 53 of file namespacenode.cpp.

◆ setDocNode()

void NamespaceNode::setDocNode ( NamespaceNode * ns)
inline

Called in QDocDatabase::resolveNamespaces() to set the pointer to the NamespaceNode in which this namespace is documented.

See also
QDocDatabase::resolveNamespaces()

Definition at line 35 of file namespacenode.h.

◆ setTree()

void NamespaceNode::setTree ( Tree * t)
inline

Sets the Tree pointer to t, which means this NamespaceNode is in the Tree t.

Definition at line 27 of file namespacenode.h.

◆ setWhereDocumented()

void NamespaceNode::setWhereDocumented ( const QString & t)
inline

Sets the camel case name of the module where this namespace is documented to the module named t.

This function is called when the {\namespace} command is processed to let qdoc know that this namespace is documented in the current module, so that when something in another module is marked as related to this namespace, it can be documented there with a ProxyNode for this namespace.

See also
whereDocumented()

Definition at line 30 of file namespacenode.h.

◆ tree()

Tree * NamespaceNode::tree ( ) const
inlinenodiscardoverridevirtual

Returns a pointer to the Tree that contains this NamespaceNode.

This requires traversing the parent() pointers to the root of the Tree, which is the unnamed NamespaceNode.

Reimplemented from Node< _Tp >.

Definition at line 21 of file namespacenode.h.

References Node< _Tp >::parent().

Referenced by HtmlGenerator::generateCppReferencePage(), processQdocconfFile(), and CppCodeParser::processTopicCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ wasSeen()

bool NamespaceNode::wasSeen ( ) const
inlinenodiscardoverridevirtual

Returns true if the {\namespace} command that this NamespaceNode represents has been parsed by qdoc.

When false is returned, it means that only {\relates} commands have been seen that relate elements to this namespace.

Reimplemented from Node< _Tp >.

Definition at line 25 of file namespacenode.h.

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