A struct for indicating that a ClassNode is related in some way to another ClassNode. More...

#include <relatedclass.h>

Collaboration diagram for RelatedClass:

Public Member Functions
	RelatedClass ()=default
	The default constructor does nothing.

	RelatedClass (Access access, ClassNode *node)
	This is the constructor used when the related class has been resolved.

	RelatedClass (Access access, QStringList path)

bool	isPrivate () const
	Returns `true` if this RelatedClass is marked as Access::Private.

Public Attributes
Access	m_access {}

ClassNode *	m_node { nullptr }

QStringList	m_path {}

Detailed Description

A struct for indicating that a ClassNode is related in some way to another ClassNode.

This struct has nothing to do with the {\relates} command. This struct is used for indicating that a ClassNode is a base class of another ClassNode, is a derived class of another ClassNode, or is an ignored base class of another ClassNode. This struct is only used in ClassNode.

Definition at line 18 of file relatedclass.h.

Constructor & Destructor Documentation

◆ RelatedClass() [1/3]

RelatedClass::RelatedClass ( )

default

The default constructor does nothing.

It is only used for allocating empty instances of RelatedClass in containers.

◆ RelatedClass() [2/3]

RelatedClass::RelatedClass	(	Access	access,
		ClassNode *	node )

inline

This is the constructor used when the related class has been resolved.

In other words, when the ClassNode has been created so that node is not nullptr.

Definition at line 22 of file relatedclass.h.

References m_access, and m_node.

Referenced by ClassNode::addResolvedBaseClass().

Here is the caller graph for this function:

◆ RelatedClass() [3/3]

RelatedClass::RelatedClass	(	Access	access,
		QStringList	path )

inline

Definition at line 24 of file relatedclass.h.

References m_access.

Member Function Documentation

◆ isPrivate()

bool RelatedClass::isPrivate ( ) const

nodiscard

Returns true if this RelatedClass is marked as Access::Private.

Definition at line 42 of file relatedclass.cpp.

Member Data Documentation

◆ m_access

Access RelatedClass::m_access {}

Definition at line 27 of file relatedclass.h.

Referenced by RelatedClass(), and RelatedClass().

◆ m_node

ClassNode* RelatedClass::m_node { nullptr }

Definition at line 28 of file relatedclass.h.

Referenced by RelatedClass().

◆ m_path

QStringList RelatedClass::m_path {}

Definition at line 29 of file relatedclass.h.

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

qttools/src/qdoc/qdoc/src/qdoc/relatedclass.h (5212645b4665917019a96ba873d9e98c1a136b5f)
qttools/src/qdoc/qdoc/src/qdoc/relatedclass.cpp (5212645b4665917019a96ba873d9e98c1a136b5f)

Public Member Functions

Public Attributes