@@ -38,10 +38,21 @@ namespace boilerplateCodeDoc {
38
38
// / @return if success returns true, otherwise false.
39
39
explicit JsonSchema (std::string filename);
40
40
41
+ // / @brief Error code
41
42
ParseErrorCode error {ParseErrorCode::OK};
43
+
44
+ // /@brief Error message
42
45
std::string message {}; // error message
43
- void * document_ptr {nullptr }; // void to avoid rapidjson dependencies
46
+
47
+ // /@brief Internal pointer: void to avoid rapidjson dependencies
48
+ void * document_ptr {nullptr };
49
+
50
+ // /@brief Json Schema title
51
+ // /@remarks for debugging
44
52
std::string title {};
53
+
54
+ // /@brief Json Schema description
55
+ // /@remarks for debugging
45
56
std::string description {};
46
57
};
47
58
@@ -52,6 +63,9 @@ namespace boilerplateCodeDoc {
52
63
// /@brief typical virtual destructor just in case
53
64
virtual ~JsonSchemaFilter () = default ;
54
65
66
+ // /@brief simplest consturctor
67
+ JsonSchemaFilter (std::string header_ = " " , std::string footer_ = " " ) : header{std::move (header_)}, footer{std::move (footer_)} {}
68
+
55
69
// /@brief Error code
56
70
ParseErrorCode error {ParseErrorCode::OK};
57
71
@@ -64,6 +78,14 @@ namespace boilerplateCodeDoc {
64
78
65
79
// /@brief result of that filter
66
80
std::string filtered {};
81
+
82
+ // /@brief preambule
83
+ // / @remark to override
84
+ std::string header {};
85
+
86
+ // /@brief ending
87
+ // / @remark to override
88
+ std::string footer {};
67
89
};
68
90
69
91
@@ -103,17 +125,15 @@ namespace boilerplateCodeDoc {
103
125
</html>
104
126
)" };
105
127
128
+ // /@brief simplest constructor
129
+ JsonSchema2HTML (std::string header_ = HEADER, std::string footer_ = FOOTER, std::string css_id_ = CSS_ID) :
130
+ JsonSchemaFilter (header_, footer_), css_id{std::move (css_id_)} {}
131
+
106
132
// /@brief filter to apply
107
133
bool operator ()(const JsonSchema& jsonSchema) override ;
108
134
109
135
// /@brief css id to be added to generated tables
110
- std::string css_id {CSS_ID};
111
-
112
- // /@brief HTML page header
113
- std::string header {HEADER};
114
-
115
- // /@brief HTML page footer
116
- std::string footer {FOOTER};
136
+ std::string css_id {};
117
137
};
118
138
119
139
} // namespace
0 commit comments