Skip to content

Commit 252c545

Browse files
committed
Add doxygen documentation
1 parent 4bad4dd commit 252c545

File tree

7 files changed

+228
-59
lines changed

7 files changed

+228
-59
lines changed

docs/reference/html/annotated.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@
129129
<tr id="row_0_20_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_20_" class="arrow" onclick="toggleFolder('0_20_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structjinja2_1_1_settings.html" target="_self">Settings</a></td><td class="desc"></td></tr>
130130
<tr id="row_0_20_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structjinja2_1_1_settings_1_1_extensions.html" target="_self">Extensions</a></td><td class="desc"></td></tr>
131131
<tr id="row_0_21_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structjinja2_1_1_source_location.html" target="_self">SourceLocation</a></td><td class="desc"></td></tr>
132-
<tr id="row_0_22_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classjinja2_1_1_template.html" target="_self">Template</a></td><td class="desc"></td></tr>
132+
<tr id="row_0_22_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classjinja2_1_1_template.html" target="_self">Template</a></td><td class="desc"><a class="el" href="classjinja2_1_1_template.html" title="Template object which is used to render narrow char templates.">Template</a> object which is used to render narrow char templates </td></tr>
133133
<tr id="row_0_23_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classjinja2_1_1_template_env.html" target="_self">TemplateEnv</a></td><td class="desc"></td></tr>
134134
<tr id="row_0_24_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classjinja2_1_1_template_impl.html" target="_self">TemplateImpl</a></td><td class="desc"></td></tr>
135135
<tr id="row_0_25_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classjinja2_1_1_template_w.html" target="_self">TemplateW</a></td><td class="desc"></td></tr>

docs/reference/html/classjinja2_1_1_template.html

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,35 +98,48 @@
9898
</div><!--header-->
9999
<div class="contents">
100100

101+
<p><a class="el" href="classjinja2_1_1_template.html" title="Template object which is used to render narrow char templates.">Template</a> object which is used to render narrow char templates.
102+
<a href="classjinja2_1_1_template.html#details">More...</a></p>
103+
101104
<p><code>#include &lt;<a class="el" href="template_8h_source.html">template.h</a>&gt;</code></p>
102105
<table class="memberdecls">
103106
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
104107
Public Member Functions</h2></td></tr>
105108
<tr class="memitem:aac89f712877d1c411413c00981a9ad0b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjinja2_1_1_template.html#aac89f712877d1c411413c00981a9ad0b">Template</a> ()</td></tr>
109+
<tr class="memdesc:aac89f712877d1c411413c00981a9ad0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <a href="classjinja2_1_1_template.html#aac89f712877d1c411413c00981a9ad0b">More...</a><br /></td></tr>
106110
<tr class="separator:aac89f712877d1c411413c00981a9ad0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
107111
<tr class="memitem:a8a3900030df201a6bfdb35cd6c44c897"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjinja2_1_1_template.html#a8a3900030df201a6bfdb35cd6c44c897">Template</a> (<a class="el" href="classjinja2_1_1_template_env.html">TemplateEnv</a> *env)</td></tr>
112+
<tr class="memdesc:a8a3900030df201a6bfdb35cd6c44c897"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializing constructor. <a href="classjinja2_1_1_template.html#a8a3900030df201a6bfdb35cd6c44c897">More...</a><br /></td></tr>
108113
<tr class="separator:a8a3900030df201a6bfdb35cd6c44c897"><td class="memSeparator" colspan="2">&#160;</td></tr>
109114
<tr class="memitem:a786aba2c39b88ad0540c1808624e11f9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjinja2_1_1_template.html#a786aba2c39b88ad0540c1808624e11f9">~Template</a> ()</td></tr>
110115
<tr class="separator:a786aba2c39b88ad0540c1808624e11f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
111116
<tr class="memitem:a3c4a2705c8d281271dc36e5c7d1643a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacejinja2.html#a1784344a249a9262f9fc9faba62c66c9">Result</a>&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjinja2_1_1_template.html#a3c4a2705c8d281271dc36e5c7d1643a4">Load</a> (const char *tpl, std::string tplName=std::string())</td></tr>
117+
<tr class="memdesc:a3c4a2705c8d281271dc36e5c7d1643a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load template from the zero-terminated narrow char string. <a href="classjinja2_1_1_template.html#a3c4a2705c8d281271dc36e5c7d1643a4">More...</a><br /></td></tr>
112118
<tr class="separator:a3c4a2705c8d281271dc36e5c7d1643a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
113119
<tr class="memitem:a406e6aad7df0a661519a858d3e40aa09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacejinja2.html#a1784344a249a9262f9fc9faba62c66c9">Result</a>&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjinja2_1_1_template.html#a406e6aad7df0a661519a858d3e40aa09">Load</a> (const std::string &amp;str, std::string tplName=std::string())</td></tr>
120+
<tr class="memdesc:a406e6aad7df0a661519a858d3e40aa09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load template from the std::string. <a href="classjinja2_1_1_template.html#a406e6aad7df0a661519a858d3e40aa09">More...</a><br /></td></tr>
114121
<tr class="separator:a406e6aad7df0a661519a858d3e40aa09"><td class="memSeparator" colspan="2">&#160;</td></tr>
115122
<tr class="memitem:aa9220ec3ee1953c20d16f38142f94465"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacejinja2.html#a1784344a249a9262f9fc9faba62c66c9">Result</a>&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjinja2_1_1_template.html#aa9220ec3ee1953c20d16f38142f94465">Load</a> (std::istream &amp;stream, std::string tplName=std::string())</td></tr>
123+
<tr class="memdesc:aa9220ec3ee1953c20d16f38142f94465"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load template from the stream. <a href="classjinja2_1_1_template.html#aa9220ec3ee1953c20d16f38142f94465">More...</a><br /></td></tr>
116124
<tr class="separator:aa9220ec3ee1953c20d16f38142f94465"><td class="memSeparator" colspan="2">&#160;</td></tr>
117125
<tr class="memitem:ac005e76046969f9bf81c2f3257e630e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacejinja2.html#a1784344a249a9262f9fc9faba62c66c9">Result</a>&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjinja2_1_1_template.html#ac005e76046969f9bf81c2f3257e630e4">LoadFromFile</a> (const std::string &amp;fileName)</td></tr>
126+
<tr class="memdesc:ac005e76046969f9bf81c2f3257e630e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load template from the specified file. <a href="classjinja2_1_1_template.html#ac005e76046969f9bf81c2f3257e630e4">More...</a><br /></td></tr>
118127
<tr class="separator:ac005e76046969f9bf81c2f3257e630e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
119128
<tr class="memitem:a471750a94036f4ceffe9aaa159f46615"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacejinja2.html#a1784344a249a9262f9fc9faba62c66c9">Result</a>&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjinja2_1_1_template.html#a471750a94036f4ceffe9aaa159f46615">Render</a> (std::ostream &amp;os, const <a class="el" href="namespacejinja2.html#a43543ac86dc683e719bbec4e565dfc8f">ValuesMap</a> &amp;params)</td></tr>
129+
<tr class="memdesc:a471750a94036f4ceffe9aaa159f46615"><td class="mdescLeft">&#160;</td><td class="mdescRight">Render previously loaded template to the narrow char stream. <a href="classjinja2_1_1_template.html#a471750a94036f4ceffe9aaa159f46615">More...</a><br /></td></tr>
120130
<tr class="separator:a471750a94036f4ceffe9aaa159f46615"><td class="memSeparator" colspan="2">&#160;</td></tr>
121131
<tr class="memitem:aecba9a5cae9f93f7c54598f5270e80de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacejinja2.html#a1784344a249a9262f9fc9faba62c66c9">Result</a>&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjinja2_1_1_template.html#aecba9a5cae9f93f7c54598f5270e80de">RenderAsString</a> (const <a class="el" href="namespacejinja2.html#a43543ac86dc683e719bbec4e565dfc8f">ValuesMap</a> &amp;params)</td></tr>
132+
<tr class="memdesc:aecba9a5cae9f93f7c54598f5270e80de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Render previously loaded template to the narrow char string. <a href="classjinja2_1_1_template.html#aecba9a5cae9f93f7c54598f5270e80de">More...</a><br /></td></tr>
122133
<tr class="separator:aecba9a5cae9f93f7c54598f5270e80de"><td class="memSeparator" colspan="2">&#160;</td></tr>
123134
</table><table class="memberdecls">
124135
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
125136
Friends</h2></td></tr>
126137
<tr class="memitem:ab75e5554788c8dc705abb809e7373c45"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjinja2_1_1_template.html#ab75e5554788c8dc705abb809e7373c45">TemplateImpl&lt; char &gt;</a></td></tr>
127138
<tr class="separator:ab75e5554788c8dc705abb809e7373c45"><td class="memSeparator" colspan="2">&#160;</td></tr>
128139
</table>
129-
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
140+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
141+
<div class="textblock"><p><a class="el" href="classjinja2_1_1_template.html" title="Template object which is used to render narrow char templates.">Template</a> object which is used to render narrow char templates. </p>
142+
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
130143
<a id="aac89f712877d1c411413c00981a9ad0b"></a>
131144
<h2 class="memtitle"><span class="permalink"><a href="#aac89f712877d1c411413c00981a9ad0b">&#9670;&nbsp;</a></span>Template() <span class="overload">[1/2]</span></h2>
132145

@@ -150,6 +163,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#aac89f712877d1c411413c009
150163
</table>
151164
</div><div class="memdoc">
152165

166+
<p>Default constructor. </p>
167+
153168
</div>
154169
</div>
155170
<a id="a8a3900030df201a6bfdb35cd6c44c897"></a>
@@ -176,6 +191,15 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8a3900030df201a6bfdb35cd
176191
</table>
177192
</div><div class="memdoc">
178193

194+
<p>Initializing constructor. </p>
195+
<p>Creates instance of the template with the specified template environment object</p>
196+
<dl class="params"><dt>Parameters</dt><dd>
197+
<table class="params">
198+
<tr><td class="paramname">env</td><td><a class="el" href="classjinja2_1_1_template.html" title="Template object which is used to render narrow char templates.">Template</a> environment object which created template should refer to </td></tr>
199+
</table>
200+
</dd>
201+
</dl>
202+
179203
</div>
180204
</div>
181205
<a id="a786aba2c39b88ad0540c1808624e11f9"></a>
@@ -192,6 +216,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a786aba2c39b88ad0540c1808
192216
</tr>
193217
</table>
194218
</div><div class="memdoc">
219+
<p>Destructor </p>
195220

196221
</div>
197222
</div>
@@ -222,6 +247,17 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3c4a2705c8d281271dc36e5c
222247
</table>
223248
</div><div class="memdoc">
224249

250+
<p>Load template from the zero-terminated narrow char string. </p>
251+
<p>Takes specified narrow char string and parses it as a Jinja2 template. In case of error returns detailed diagnostic</p>
252+
<dl class="params"><dt>Parameters</dt><dd>
253+
<table class="params">
254+
<tr><td class="paramname">tpl</td><td>Zero-terminated narrow char string with template description </td></tr>
255+
<tr><td class="paramname">tplName</td><td>Optional name of the template (for the error reporting purposes)</td></tr>
256+
</table>
257+
</dd>
258+
</dl>
259+
<dl class="section return"><dt>Returns</dt><dd>Either noting or instance of <a class="el" href="classjinja2_1_1_error_info_tpl.html">ErrorInfoTpl</a> as an error </dd></dl>
260+
225261
</div>
226262
</div>
227263
<a id="a406e6aad7df0a661519a858d3e40aa09"></a>
@@ -250,6 +286,17 @@ <h2 class="memtitle"><span class="permalink"><a href="#a406e6aad7df0a661519a858d
250286
</table>
251287
</div><div class="memdoc">
252288

289+
<p>Load template from the std::string. </p>
290+
<p>Takes specified std::string object and parses it as a Jinja2 template. In case of error returns detailed diagnostic</p>
291+
<dl class="params"><dt>Parameters</dt><dd>
292+
<table class="params">
293+
<tr><td class="paramname">tpl</td><td>std::string object with template description </td></tr>
294+
<tr><td class="paramname">tplName</td><td>Optional name of the template (for the error reporting purposes)</td></tr>
295+
</table>
296+
</dd>
297+
</dl>
298+
<dl class="section return"><dt>Returns</dt><dd>Either noting or instance of <a class="el" href="classjinja2_1_1_error_info_tpl.html">ErrorInfoTpl</a> as an error </dd></dl>
299+
253300
</div>
254301
</div>
255302
<a id="aa9220ec3ee1953c20d16f38142f94465"></a>
@@ -278,6 +325,17 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa9220ec3ee1953c20d16f381
278325
</table>
279326
</div><div class="memdoc">
280327

328+
<p>Load template from the stream. </p>
329+
<p>Takes specified stream object and parses it as a source of Jinja2 template. In case of error returns detailed diagnostic</p>
330+
<dl class="params"><dt>Parameters</dt><dd>
331+
<table class="params">
332+
<tr><td class="paramname">tpl</td><td>Stream object with template description </td></tr>
333+
<tr><td class="paramname">tplName</td><td>Optional name of the template (for the error reporting purposes)</td></tr>
334+
</table>
335+
</dd>
336+
</dl>
337+
<dl class="section return"><dt>Returns</dt><dd>Either noting or instance of <a class="el" href="classjinja2_1_1_error_info_tpl.html">ErrorInfoTpl</a> as an error </dd></dl>
338+
281339
</div>
282340
</div>
283341
<a id="ac005e76046969f9bf81c2f3257e630e4"></a>
@@ -296,6 +354,16 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac005e76046969f9bf81c2f32
296354
</table>
297355
</div><div class="memdoc">
298356

357+
<p>Load template from the specified file. </p>
358+
<p>Loads file with the specified name and parses it as a source of Jinja2 template. In case of error returns detailed diagnostic</p>
359+
<dl class="params"><dt>Parameters</dt><dd>
360+
<table class="params">
361+
<tr><td class="paramname">fileName</td><td>Name of the file to load</td></tr>
362+
</table>
363+
</dd>
364+
</dl>
365+
<dl class="section return"><dt>Returns</dt><dd>Either noting or instance of <a class="el" href="classjinja2_1_1_error_info_tpl.html">ErrorInfoTpl</a> as an error </dd></dl>
366+
299367
</div>
300368
</div>
301369
<a id="a471750a94036f4ceffe9aaa159f46615"></a>
@@ -324,6 +392,17 @@ <h2 class="memtitle"><span class="permalink"><a href="#a471750a94036f4ceffe9aaa1
324392
</table>
325393
</div><div class="memdoc">
326394

395+
<p>Render previously loaded template to the narrow char stream. </p>
396+
<p>Renders previously loaded template to the specified narrow char stream and specified set of params.</p>
397+
<dl class="params"><dt>Parameters</dt><dd>
398+
<table class="params">
399+
<tr><td class="paramname">os</td><td>Stream to render template to </td></tr>
400+
<tr><td class="paramname">params</td><td>Set of params which should be passed to the template engine and can be used within the template</td></tr>
401+
</table>
402+
</dd>
403+
</dl>
404+
<dl class="section return"><dt>Returns</dt><dd>Either noting or instance of <a class="el" href="classjinja2_1_1_error_info_tpl.html">ErrorInfoTpl</a> as an error </dd></dl>
405+
327406
</div>
328407
</div>
329408
<a id="aecba9a5cae9f93f7c54598f5270e80de"></a>
@@ -342,6 +421,16 @@ <h2 class="memtitle"><span class="permalink"><a href="#aecba9a5cae9f93f7c54598f5
342421
</table>
343422
</div><div class="memdoc">
344423

424+
<p>Render previously loaded template to the narrow char string. </p>
425+
<p>Renders previously loaded template as a narrow char string and with specified set of params.</p>
426+
<dl class="params"><dt>Parameters</dt><dd>
427+
<table class="params">
428+
<tr><td class="paramname">params</td><td>Set of params which should be passed to the template engine and can be used within the template</td></tr>
429+
</table>
430+
</dd>
431+
</dl>
432+
<dl class="section return"><dt>Returns</dt><dd>Either rendered string or instance of <a class="el" href="classjinja2_1_1_error_info_tpl.html">ErrorInfoTpl</a> as an error </dd></dl>
433+
345434
</div>
346435
</div>
347436
<h2 class="groupheader">Friends And Related Function Documentation</h2>

docs/reference/html/hierarchy.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@
142142
<tr id="row_22_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classjinja2_1_1_reflected_data_holder_3_01_t_00_01true_01_4.html" target="_self">jinja2::ReflectedDataHolder&lt; T, true &gt;</a></td><td class="desc"></td></tr>
143143
<tr id="row_23_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structjinja2_1_1_settings.html" target="_self">jinja2::Settings</a></td><td class="desc"></td></tr>
144144
<tr id="row_24_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structjinja2_1_1_source_location.html" target="_self">jinja2::SourceLocation</a></td><td class="desc"></td></tr>
145-
<tr id="row_25_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classjinja2_1_1_template.html" target="_self">jinja2::Template</a></td><td class="desc"></td></tr>
145+
<tr id="row_25_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classjinja2_1_1_template.html" target="_self">jinja2::Template</a></td><td class="desc"><a class="el" href="classjinja2_1_1_template.html" title="Template object which is used to render narrow char templates.">Template</a> object which is used to render narrow char templates </td></tr>
146146
<tr id="row_26_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classjinja2_1_1_template_env.html" target="_self">jinja2::TemplateEnv</a></td><td class="desc"></td></tr>
147147
<tr id="row_27_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classjinja2_1_1_template_impl.html" target="_self">jinja2::TemplateImpl&lt; CharT &gt;</a></td><td class="desc"></td></tr>
148148
<tr id="row_28_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classjinja2_1_1_template_w.html" target="_self">jinja2::TemplateW</a></td><td class="desc"></td></tr>

0 commit comments

Comments
 (0)