aggregate.cpp File Reference

(109b02543e3f95c0e201ad0ae5a73b57cc30afa2)

#include "aggregate.h"
#include "config.h"
#include "functionnode.h"
#include "inclusionfilter.h"
#include "inclusionpolicy.h"
#include "parameters.h"
#include "typedefnode.h"
#include "qdocdatabase.h"
#include "qmlpropertynode.h"
#include "qmltypenode.h"
#include "sharedcommentnode.h"
#include <vector>

Include dependency graph for aggregate.cpp:

Go to the source code of this file.

Functions
static void	warnAboutDocumentedChildInUndocumentedParent (const Node *aggregate, const Node *child)
static bool	keep (FunctionNode *fn)

Function Documentation

keep()

bool keep ( FunctionNode * fn )

static

Definition at line 559 of file aggregate.cpp.

References FunctionNode::isDeprecated(), FunctionNode::isDtor(), Node< _Tp >::isInternal(), Node< _Tp >::isPrivate(), and FunctionNode::isSomeCtor().

Here is the call graph for this function:

warnAboutDocumentedChildInUndocumentedParent()

void warnAboutDocumentedChildInUndocumentedParent ( const Node * aggregate, const Node * child )

static

Warn about documented, non-private children under undocumented parents - unless the child is explicitly set

, or their parent() does not match aggregate, indicating that child is a related non-member. The latter condition avoids duplicate warnings as the node appears under multiple aggregates.

The warning is skipped for children of proxy nodes and namespace nodes. Proxies have no documentation as they're automatically generated. For namespaces, this check is done separately after merging potentially multiple namespace nodes referring to the same namespace; see NamespaceNode::reportDocumentedChildrenInUndocumentedNamespace().

Likewise, the warning is skipped for children of aggregates marked with the \dontdocument command.

If either {-no-linkerrors} or {-showinternal} command-line option is set, these warnings are not generated. {-no-linkerrors} avoids false positives in cases where the aggregate is documented outside the current project and was not loaded from index. With {-showinternal} set, the warning is not required as internal nodes generate output.

Definition at line 244 of file aggregate.cpp.

References Node< _Tp >::hasDoc(), Node< _Tp >::Internal, Node< _Tp >::isDontDocument(), Node< _Tp >::isNamespace(), Node< _Tp >::isPrivate(), Node< _Tp >::isProxyNode(), Node< _Tp >::parent(), and Node< _Tp >::status().

Here is the call graph for this function: