AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
|
A Writer that is able to write the input file schema in JSON Schema format for a given input file. More...
#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/inlet/JSONSchemaWriter.hpp>
Public Member Functions | |
JSONSchemaWriter (const std::string &fileName) | |
A constructor for JSONSchemaWriter. 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 | ~JSONSchemaWriter ()=default |
A Writer that is able to write the input file schema in JSON Schema format for a given input file.
axom::inlet::JSONSchemaWriter::JSONSchemaWriter | ( | const std::string & | fileName | ) |
A constructor for JSONSchemaWriter.
[in] | fileName | The name of the file the schema should be written to. |
|
virtualdefault |
|
overridevirtual |
Generates documentation for a Container and its child Fields/Functions.
[in] | container | The Container to generate documentation for |
Implements axom::inlet::Writer.
|
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
Implements axom::inlet::Writer.