Blaze 0.0.1
The ultra high-performance JSON Schema evaluator
Loading...
Searching...
No Matches
documentation.h
1#ifndef SOURCEMETA_BLAZE_DOCUMENTATION_H_
2#define SOURCEMETA_BLAZE_DOCUMENTATION_H_
3
19
20#ifndef SOURCEMETA_BLAZE_DOCUMENTATION_EXPORT
21#include <sourcemeta/blaze/documentation_export.h>
22#endif
23
24// NOLINTBEGIN(misc-include-cleaner)
25#include <sourcemeta/blaze/documentation_error.h>
26// NOLINTEND(misc-include-cleaner)
27
28#include <sourcemeta/core/json.h>
29#include <sourcemeta/core/jsonschema.h>
30
31#include <string> // std::string
32#include <string_view> // std::string_view
33
34namespace sourcemeta::blaze {
35
39constexpr std::string_view DOCUMENTATION_FORMAT{
40 "tag:sourcemeta.com,2026:table-format/2"};
41
69[[nodiscard]] SOURCEMETA_BLAZE_DOCUMENTATION_EXPORT auto
70to_documentation(const sourcemeta::core::JSON &schema,
71 const sourcemeta::core::SchemaWalker &walker,
72 const sourcemeta::core::SchemaResolver &resolver,
73 const std::string_view default_dialect = "")
74 -> sourcemeta::core::JSON;
75
106SOURCEMETA_BLAZE_DOCUMENTATION_EXPORT auto
107to_html(const sourcemeta::core::JSON &documentation, std::string &output,
108 const bool pretty = false) -> void;
109
110} // namespace sourcemeta::blaze
111
112#endif
SOURCEMETA_BLAZE_DOCUMENTATION_EXPORT auto to_documentation(const sourcemeta::core::JSON &schema, const sourcemeta::core::SchemaWalker &walker, const sourcemeta::core::SchemaResolver &resolver, const std::string_view default_dialect="") -> sourcemeta::core::JSON
SOURCEMETA_BLAZE_DOCUMENTATION_EXPORT auto to_html(const sourcemeta::core::JSON &documentation, std::string &output, const bool pretty=false) -> void
constexpr std::string_view DOCUMENTATION_FORMAT
Definition documentation.h:39