InclusionFilter Class Reference

#include <inclusionfilter.h>

Collaboration diagram for InclusionFilter:

Static Public Member Functions
static bool	isIncluded (const InclusionPolicy &policy, const NodeContext &context)
static bool	requiresDocumentation (const InclusionPolicy &policy, const NodeContext &context)
static bool	isPubliclyVisible (const InclusionPolicy &policy, const NodeContext &context)
static bool	processInternalDocs (const InclusionPolicy &policy)
static bool	isReimplementedMemberVisible (const InclusionPolicy &policy, const NodeContext &context)

Detailed Description

Definition at line 14 of file inclusionfilter.h.

Member Function Documentation

isIncluded()

bool InclusionFilter::isIncluded ( const InclusionPolicy & policy, const NodeContext & context )

inlinestaticnodiscard

Definition at line 16 of file inclusionfilter.h.

References NodeContext::hasAutoGeneratedDoc, NodeContext::isInternal, NodeContext::isPrivate, and NodeContext::isPureVirtual.

Referenced by Sections::buildStdCppClassRefPageSections(), Generator::fileBase(), DocBookGenerator::generateDocBookSynopsis(), DocBookGenerator::generateDocumentation(), Generator::generateDocumentation(), WebXMLGenerator::generateDocumentation(), DocBookGenerator::generateQmlRequisites(), Section::insert(), Node< _Tp >::isInAPI(), and isReimplementedMemberVisible().

Here is the caller graph for this function:

isPubliclyVisible()

bool InclusionFilter::isPubliclyVisible ( const InclusionPolicy & policy, const NodeContext & context )

inlinestaticnodiscard

Definition at line 53 of file inclusionfilter.h.

References NodeContext::isInternal.

isReimplementedMemberVisible()

bool InclusionFilter::isReimplementedMemberVisible ( const InclusionPolicy & policy, const NodeContext & context )

inlinestaticnodiscard

Definition at line 62 of file inclusionfilter.h.

References isIncluded(), NodeContext::isInternal, NodeContext::isPrivate, and NodeContext::isPureVirtual.

Referenced by Section::insertReimplementedMember().

Here is the call graph for this function:

Here is the caller graph for this function:

processInternalDocs()

bool InclusionFilter::processInternalDocs ( const InclusionPolicy & policy )

inlinestaticnodiscard

Definition at line 58 of file inclusionfilter.h.

Referenced by CodeParser::isWorthWarningAbout(), Node< _Tp >::setStatus(), and warnAboutDocumentedChildInUndocumentedParent().

Here is the caller graph for this function:

requiresDocumentation()

bool InclusionFilter::requiresDocumentation ( const InclusionPolicy & policy, const NodeContext & context )

inlinestaticnodiscard

Definition at line 36 of file inclusionfilter.h.

References NodeContext::hasAutoGeneratedDoc, NodeContext::isInternal, and NodeContext::isPrivate.

Referenced by Generator::generateBody().

Here is the caller graph for this function:

---

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

• qttools/src/qdoc/qdoc/src/qdoc/inclusionfilter.h (3b1310507e81765360710e63abbd04aad3aea04c)