A Writer that is able write documentation in Sphinx RST format for a given input file. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/inlet/SphinxWriter.hpp>

Inheritance diagram for axom::inlet::SphinxWriter:

Public Member Functions
	SphinxWriter (const std::string &fileName)
	A constructor for SphinxWriter. More...

void	documentContainer (const Container &container) override
	Generates documentation for a Container and its child Fields/Functions. More...

void	finalize () override
	Finalizes documentation generation (e.g., by writing it to a file) More...

virtual	~SphinxWriter ()=default

Detailed Description

A Writer that is able write documentation in Sphinx RST format for a given input file.

Constructor & Destructor Documentation

axom::inlet::SphinxWriter::SphinxWriter ( const std::string & fileName )

A constructor for SphinxWriter.

Parameters

[in] fileName The name of the file the documentation should be written to.

virtual axom::inlet::SphinxWriter::~SphinxWriter ( )

virtualdefault

void axom::inlet::SphinxWriter::documentContainer ( const Container & container )

overridevirtual

Generates documentation for a Container and its child Fields/Functions.

Parameters

[in] container The Container to generate documentation for

Note: Implementers of this function are not responsible for generating documentation for child Containers of this Container - only child Fields/Functions

void axom::inlet::SphinxWriter::finalize ( )

overridevirtual

Finalizes documentation generation (e.g., by writing it to a file)

This is a hint to implementers that no further containers will be documented

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

/home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/inlet/SphinxWriter.hpp