axom::inlet::Writer Class Referenceabstract
Abstract base class defining the interface of all Writer classes. More...
#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/inlet/Writer.hpp>
Inheritance diagram for axom::inlet::Writer:
Public Member Functions | |
| virtual | ~Writer ()=default |
| virtual void | documentContainer (const Container &container)=0 |
| Generates documentation for a Container and its child Fields/Functions. More... | |
| virtual void | finalize ()=0 |
| Finalizes documentation generation (e.g., by writing it to a file) More... | |
Detailed Description
Abstract base class defining the interface of all Writer classes.
Concrete instances need to inherit from this class and implement these functions.
- See also
- SphinxWriter
Constructor & Destructor Documentation
◆ ~Writer()
|
virtualdefault |
Member Function Documentation
◆ documentContainer()
|
pure virtual |
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
Implemented in axom::inlet::SphinxWriter, and axom::inlet::JSONSchemaWriter.
◆ finalize()
|
pure virtual |
Finalizes documentation generation (e.g., by writing it to a file)
This is a hint to implementers that no further containers will be documented
Implemented in axom::inlet::SphinxWriter, and axom::inlet::JSONSchemaWriter.
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/inlet/Writer.hpp
