IOutputProducer Class Reference

Interface for documentation output producers. More...

#include <ioutputproducer.h>

Inheritance diagram for IOutputProducer:

Collaboration diagram for IOutputProducer:

Public Member Functions
virtual	~IOutputProducer ()=default
virtual QString	format () const =0
	Returns the format identifier for this producer (e.g., "HTML", "DocBook", "template").
virtual void	prepare ()=0
	Prepares the producer for an output run.
virtual void	produce ()=0
	Produces documentation output.
virtual void	finalize ()=0
	Finalizes output production.

Detailed Description

Interface for documentation output producers.

IOutputProducer defines the minimal contract for classes that generate documentation output. This interface decouples the generation lifecycle from any particular implementation, enabling both stateful and stateless producers to participate in QDoc's output pipeline.

Implementations are selected using their format() identifier.

See also

Generator, TemplateGenerator

Definition at line 25 of file ioutputproducer.h.

Constructor & Destructor Documentation

~IOutputProducer()

virtual IOutputProducer::~IOutputProducer ( )

virtualdefault

Member Function Documentation

finalize()

virtual void IOutputProducer::finalize ( )

pure virtual

Finalizes output production.

Called once per format at the end of the run.

Implemented in Generator.

format()

virtual QString IOutputProducer::format ( ) const

nodiscardpure virtual

Returns the format identifier for this producer (e.g., "HTML", "DocBook", "template").

Used for format selection and matching. The identifier is case-sensitive and must match the value used in configuration files.

Implemented in DocBookGenerator, Generator, HtmlGenerator, TemplateGenerator, and WebXMLGenerator.

prepare()

virtual void IOutputProducer::prepare ( )

pure virtual

Prepares the producer for an output run.

Called once per format after configuration is loaded.

Implemented in Generator.

produce()

virtual void IOutputProducer::produce ( )

pure virtual

Produces documentation output.

Called after prepare() to create the actual documentation files.

Implemented in Generator.

---

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

• qttools/src/qdoc/qdoc/src/qdoc/ioutputproducer.h (6a19bc536474a3550ffc307dbde00da622112f55)