DocumentationHandler Class Reference

Interface handling documentation generation during tree traversal. More...

#include <documentationhandler.h>

Inheritance diagram for DocumentationHandler:

Collaboration diagram for DocumentationHandler:

Public Member Functions
virtual	~DocumentationHandler ()=default
virtual void	beginDocument (const QString &fileName)=0
virtual void	endDocument ()=0
virtual QString	fileName (const Node *node) const =0
virtual void	generateCollectionNode (CollectionNode *cn, CodeMarker *marker)=0
virtual void	generateGenericCollectionPage (CollectionNode *cn, CodeMarker *marker)=0
virtual void	generatePageNode (PageNode *pn, CodeMarker *marker)=0
virtual void	generateCppReferencePage (Aggregate *aggregate, CodeMarker *marker)=0
virtual void	generateQmlTypePage (QmlTypeNode *qcn, CodeMarker *marker)=0
virtual void	generateProxyPage (Aggregate *aggregate, CodeMarker *marker)=0
virtual void	mergeCollections (CollectionNode *cn)=0

Detailed Description

Interface handling documentation generation during tree traversal.

DocumentationHandler defines the callbacks that DocumentationTraverser invokes as it walks the node tree. Implementations control file lifecycle and content generation while the traverser handles filtering, dispatch, and recursion.

This separation enables composition over inheritance: both legacy Generator and TemplateGenerator (new) can use the same traversal logic with different handler implementations.

See also

DocumentationTraverser

Definition at line 39 of file documentationhandler.h.

Constructor & Destructor Documentation

~DocumentationHandler()

virtual DocumentationHandler::~DocumentationHandler ( )

virtualdefault

Member Function Documentation

beginDocument()

virtual void DocumentationHandler::beginDocument ( const QString & fileName )

pure virtual

Implemented in TemplateGenerator.

endDocument()

virtual void DocumentationHandler::endDocument ( )

pure virtual

Implemented in TemplateGenerator.

fileName()

virtual QString DocumentationHandler::fileName ( const Node * node ) const

nodiscardpure virtual

Implemented in TemplateGenerator.

generateCollectionNode()

virtual void DocumentationHandler::generateCollectionNode ( CollectionNode * cn, CodeMarker * marker )

pure virtual

Implemented in TemplateGenerator.

generateCppReferencePage()

virtual void DocumentationHandler::generateCppReferencePage ( Aggregate * aggregate, CodeMarker * marker )

pure virtual

Implemented in TemplateGenerator.

generateGenericCollectionPage()

virtual void DocumentationHandler::generateGenericCollectionPage ( CollectionNode * cn, CodeMarker * marker )

pure virtual

Implemented in TemplateGenerator.

generatePageNode()

virtual void DocumentationHandler::generatePageNode ( PageNode * pn, CodeMarker * marker )

pure virtual

Implemented in TemplateGenerator.

generateProxyPage()

virtual void DocumentationHandler::generateProxyPage ( Aggregate * aggregate, CodeMarker * marker )

pure virtual

Implemented in TemplateGenerator.

generateQmlTypePage()

virtual void DocumentationHandler::generateQmlTypePage ( QmlTypeNode * qcn, CodeMarker * marker )

pure virtual

Implemented in TemplateGenerator.

mergeCollections()

virtual void DocumentationHandler::mergeCollections ( CollectionNode * cn )

pure virtual

Implemented in TemplateGenerator.

---

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

• qttools/src/qdoc/qdoc/src/qdoc/documentationhandler.h (32a4d609dd80d78053604da8e5ce2102e3164c35)