A DocWriter 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/v0.4.0/src/axom/inlet/SphinxDocWriter.hpp>

Inheritance diagram for axom::inlet::SphinxDocWriter:

Public Member Functions
	SphinxDocWriter (const std::string &fileName, axom::sidre::Group *sidreRootGroup)
	A constructor for SphinxDocWriter. More...

void	writeDocumentation ()
	Writes all documentation to a file. More...

virtual	~SphinxDocWriter ()=default

Detailed Description

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

Constructor & Destructor Documentation

axom::inlet::SphinxDocWriter::SphinxDocWriter	(	const std::string &	fileName,
		axom::sidre::Group *	sidreRootGroup
	)

A constructor for SphinxDocWriter.

Parameters

[in]	fileName	The name of the file the documentation should be written to.
[in]	sidreRootGroup	The root of the sidre group that will be traversed to create documentation.

virtual axom::inlet::SphinxDocWriter::~SphinxDocWriter ( )

virtualdefault

void axom::inlet::SphinxDocWriter::writeDocumentation ( )

virtual

Writes all documentation to a file.

This generates all RST-syntax documentation and writes it to the pre-specified file.

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

/home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.4.0/src/axom/inlet/SphinxDocWriter.hpp