OutputProducer Class Reference

Interface for documentation output producers. More...

#include <outputproducer.h>

Inheritance diagram for OutputProducer:

Collaboration diagram for OutputProducer:

Public Member Functions
virtual	~OutputProducer ()=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.

OutputProducer 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.

A producer instance owns exactly one output run: one format, one qdocconf, one QDoc pass. The driver constructs a fresh instance for each run and invokes the full prepare()/produce()/finalize() lifecycle only while Config::generating(). During the prepare pass (a dual-exec -prepare run, or the prepare half of a -single-exec run) the driver skips the lifecycle entirely, so an implementation must not rely on state carried across passes.

See also

Generator, TemplateGenerator

Definition at line 33 of file outputproducer.h.

Constructor & Destructor Documentation

~OutputProducer()

virtual OutputProducer::~OutputProducer ( )

virtualdefault

Member Function Documentation

finalize()

virtual void OutputProducer::finalize ( )

pure virtual

Finalizes output production.

Called once per format at the end of the run.

Implemented in Generator, and TemplateGenerator.

format()

virtual QString OutputProducer::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 OutputProducer::prepare ( )

pure virtual

Prepares the producer for an output run.

Called once per format after configuration is loaded.

Implemented in Generator, and TemplateGenerator.

produce()

virtual void OutputProducer::produce ( )

pure virtual

Produces documentation output.

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

Implemented in Generator, and TemplateGenerator.

---

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

• qttools/src/qdoc/qdoc/src/qdoc/outputproducer.h (376ec09e4f41d5986be28ac1da1a6bce347b2af7)