AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
axom::inlet::DocWriter Class Referenceabstract

Abstract base class defining the interface of all DocWriter classes. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.4.0/src/axom/inlet/DocWriter.hpp>

Inheritance diagram for axom::inlet::DocWriter:

Public Member Functions

virtual void writeDocumentation ()=0
 Write documentation for the input file to a given file. More...
 

Detailed Description

Abstract base class defining the interface of all DocWriter classes.

Concrete instances need to inherit from this class and implement these functions.

See also
SphinxDocWriter

Member Function Documentation

◆ writeDocumentation()

virtual void axom::inlet::DocWriter::writeDocumentation ( )
pure virtual

Write documentation for the input file to a given file.

This writes the documentation according to the information retrieved from the sidre group.

Implemented in axom::inlet::SphinxDocWriter.


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