Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit991494c

Browse files
committed
Jinja2C++ doxygen documentation
1 parent557067c commit991494c

File tree

148 files changed

+1774
-997
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

148 files changed

+1774
-997
lines changed

‎docs/reference/1.0/html/annotated.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,13 +119,13 @@
119119
<trid="row_0_5_0_"class="even"><tdclass="entry"><spanstyle="width:48px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="structjinja2_1_1_generic_list_iterator_1_1_cloner.html"target="_self">Cloner</a></td><tdclass="desc"></td></tr>
120120
<trid="row_0_6_"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classjinja2_1_1_generic_map.html"target="_self">GenericMap</a></td><tdclass="desc">Helper class for accessing maps specified by the<aclass="el"href="structjinja2_1_1_map_item_accessor.html">MapItemAccessor</a> interface</td></tr>
121121
<trid="row_0_7_"class="even"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classjinja2_1_1_i_error_handler.html"target="_self">IErrorHandler</a></td><tdclass="desc"></td></tr>
122-
<trid="row_0_8_"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html"target="_self">IFilesystemHandler</a></td><tdclass="desc"></td></tr>
122+
<trid="row_0_8_"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html"target="_self">IFilesystemHandler</a></td><tdclass="desc">Generic interface to filesystem handlers (loaders)</td></tr>
123123
<trid="row_0_9_"class="even"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="structjinja2_1_1_index_based_accessor.html"target="_self">IndexBasedAccessor</a></td><tdclass="desc"></td></tr>
124124
<trid="row_0_10_"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="structjinja2_1_1_list_enumerator.html"target="_self">ListEnumerator</a></td><tdclass="desc"></td></tr>
125125
<trid="row_0_11_"class="even"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="structjinja2_1_1_list_item_accessor.html"target="_self">ListItemAccessor</a></td><tdclass="desc"></td></tr>
126126
<trid="row_0_12_"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="structjinja2_1_1_map_item_accessor.html"target="_self">MapItemAccessor</a></td><tdclass="desc">Interface to the generic dictionary type which maps string to some value</td></tr>
127-
<trid="row_0_13_"class="even"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classjinja2_1_1_memory_file_system.html"target="_self">MemoryFileSystem</a></td><tdclass="desc"></td></tr>
128-
<trid="row_0_14_"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classjinja2_1_1_real_file_system.html"target="_self">RealFileSystem</a></td><tdclass="desc"></td></tr>
127+
<trid="row_0_13_"class="even"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classjinja2_1_1_memory_file_system.html"target="_self">MemoryFileSystem</a></td><tdclass="desc">Filesystem handler for files stored in memory</td></tr>
128+
<trid="row_0_14_"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classjinja2_1_1_real_file_system.html"target="_self">RealFileSystem</a></td><tdclass="desc">Filesystem handler for files stored on the filesystem</td></tr>
129129
<trid="row_0_15_"class="even"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classjinja2_1_1_reflected_data_holder.html"target="_self">ReflectedDataHolder</a></td><tdclass="desc"></td></tr>
130130
<trid="row_0_16_"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classjinja2_1_1_reflected_data_holder_3_01_t_00_01false_01_4.html"target="_self">ReflectedDataHolder&lt; T, false &gt;</a></td><tdclass="desc"></td></tr>
131131
<trid="row_0_17_"class="even"><tdclass="entry"><spanstyle="width:32px;display:inline-block;">&#160;</span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classjinja2_1_1_reflected_data_holder_3_01_t_00_01true_01_4.html"target="_self">ReflectedDataHolder&lt; T, true &gt;</a></td><tdclass="desc"></td></tr>

‎docs/reference/1.0/html/classjinja2_1_1_i_filesystem_handler-members.html‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,10 @@
101101

102102
<p>This is the complete list of members for<aclass="el"href="classjinja2_1_1_i_filesystem_handler.html">jinja2::IFilesystemHandler</a>, including all inherited members.</p>
103103
<tableclass="directory">
104-
<trclass="even"><tdclass="entry"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html#ab20beae340570f352193bd12819d8efd">OpenStream</a>(const std::string &amp;name) const =0</td><tdclass="entry"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html">jinja2::IFilesystemHandler</a></td><tdclass="entry"><spanclass="mlabel">pure virtual</span></td></tr>
105-
<tr><tdclass="entry"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html#a76b088ac5bcff7ecd673b45ef59906cb">OpenWStream</a>(const std::string &amp;name) const =0</td><tdclass="entry"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html">jinja2::IFilesystemHandler</a></td><tdclass="entry"><spanclass="mlabel">pure virtual</span></td></tr>
106-
<trclass="even"><tdclass="entry"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html#af1e98b85bed16d51148d42d64fb07e40">~IFilesystemHandler</a>()=default</td><tdclass="entry"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html">jinja2::IFilesystemHandler</a></td><tdclass="entry"><spanclass="mlabel">virtual</span></td></tr>
104+
<trclass="even"><tdclass="entry"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html#a9bceaeb724626d1f9055e5be8ee5cc9f">GetLastModificationDate</a>(const std::string &amp;name) const =0</td><tdclass="entry"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html">jinja2::IFilesystemHandler</a></td><tdclass="entry"><spanclass="mlabel">pure virtual</span></td></tr>
105+
<tr><tdclass="entry"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html#ab20beae340570f352193bd12819d8efd">OpenStream</a>(const std::string &amp;name) const =0</td><tdclass="entry"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html">jinja2::IFilesystemHandler</a></td><tdclass="entry"><spanclass="mlabel">pure virtual</span></td></tr>
106+
<trclass="even"><tdclass="entry"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html#a76b088ac5bcff7ecd673b45ef59906cb">OpenWStream</a>(const std::string &amp;name) const =0</td><tdclass="entry"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html">jinja2::IFilesystemHandler</a></td><tdclass="entry"><spanclass="mlabel">pure virtual</span></td></tr>
107+
<tr><tdclass="entry"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html#af1e98b85bed16d51148d42d64fb07e40">~IFilesystemHandler</a>()=default</td><tdclass="entry"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html">jinja2::IFilesystemHandler</a></td><tdclass="entry"><spanclass="mlabel">virtual</span></td></tr>
107108
</table></div><!-- contents -->
108109
</div><!-- doc-content -->
109110
<!-- HTML footer for doxygen 1.8.16-->

‎docs/reference/1.0/html/classjinja2_1_1_i_filesystem_handler.html‎

Lines changed: 75 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,28 +102,40 @@
102102
</div><!--header-->
103103
<divclass="contents">
104104

105+
<p>Generic interface to filesystem handlers (loaders)
106+
<ahref="classjinja2_1_1_i_filesystem_handler.html#details">More...</a></p>
107+
105108
<p><code>#include &lt;<aclass="el"href="filesystem__handler_8h_source.html">filesystem_handler.h</a>&gt;</code></p>
106109
<divclass="dynheader">
107110
Inheritance diagram for jinja2::IFilesystemHandler:</div>
108111
<divclass="dyncontent">
109112
<divclass="center">
110113
<imgsrc="classjinja2_1_1_i_filesystem_handler.png"usemap="#jinja2::IFilesystemHandler_map"alt=""/>
111114
<mapid="jinja2::IFilesystemHandler_map"name="jinja2::IFilesystemHandler_map">
112-
<areahref="classjinja2_1_1_memory_file_system.html"alt="jinja2::MemoryFileSystem"shape="rect"coords="0,56,155,80"/>
113-
<areahref="classjinja2_1_1_real_file_system.html"alt="jinja2::RealFileSystem"shape="rect"coords="165,56,320,80"/>
115+
<areahref="classjinja2_1_1_memory_file_system.html"title="Filesystem handler for files stored in memory."alt="jinja2::MemoryFileSystem"shape="rect"coords="0,56,155,80"/>
116+
<areahref="classjinja2_1_1_real_file_system.html"title="Filesystem handler for files stored on the filesystem."alt="jinja2::RealFileSystem"shape="rect"coords="165,56,320,80"/>
114117
</map>
115118
</div></div>
116119
<tableclass="memberdecls">
117120
<trclass="heading"><tdcolspan="2"><h2class="groupheader"><aname="pub-methods"></a>
118121
Public Member Functions</h2></td></tr>
119122
<trclass="memitem:af1e98b85bed16d51148d42d64fb07e40"><tdclass="memItemLeft"align="right"valign="top">virtual&#160;</td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html#af1e98b85bed16d51148d42d64fb07e40">~IFilesystemHandler</a> ()=default</td></tr>
123+
<trclass="memdesc:af1e98b85bed16d51148d42d64fb07e40"><tdclass="mdescLeft">&#160;</td><tdclass="mdescRight">Destructor.<ahref="classjinja2_1_1_i_filesystem_handler.html#af1e98b85bed16d51148d42d64fb07e40">More...</a><br/></td></tr>
120124
<trclass="separator:af1e98b85bed16d51148d42d64fb07e40"><tdclass="memSeparator"colspan="2">&#160;</td></tr>
121125
<trclass="memitem:ab20beae340570f352193bd12819d8efd"><tdclass="memItemLeft"align="right"valign="top">virtual<aclass="el"href="namespacejinja2.html#ab5d363d70df829219a7b5652328977c6">CharFileStreamPtr</a>&#160;</td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html#ab20beae340570f352193bd12819d8efd">OpenStream</a> (const std::string &amp;name) const =0</td></tr>
126+
<trclass="memdesc:ab20beae340570f352193bd12819d8efd"><tdclass="mdescLeft">&#160;</td><tdclass="mdescRight">Method is called to open the file with the specified name in 'narrow-char' mode.<ahref="classjinja2_1_1_i_filesystem_handler.html#ab20beae340570f352193bd12819d8efd">More...</a><br/></td></tr>
122127
<trclass="separator:ab20beae340570f352193bd12819d8efd"><tdclass="memSeparator"colspan="2">&#160;</td></tr>
123128
<trclass="memitem:a76b088ac5bcff7ecd673b45ef59906cb"><tdclass="memItemLeft"align="right"valign="top">virtual<aclass="el"href="namespacejinja2.html#ad07d25b586e095c48d73b504a49d4697">WCharFileStreamPtr</a>&#160;</td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html#a76b088ac5bcff7ecd673b45ef59906cb">OpenWStream</a> (const std::string &amp;name) const =0</td></tr>
129+
<trclass="memdesc:a76b088ac5bcff7ecd673b45ef59906cb"><tdclass="mdescLeft">&#160;</td><tdclass="mdescRight">Method is called to open the file with the specified name in 'wide-char' mode.<ahref="classjinja2_1_1_i_filesystem_handler.html#a76b088ac5bcff7ecd673b45ef59906cb">More...</a><br/></td></tr>
124130
<trclass="separator:a76b088ac5bcff7ecd673b45ef59906cb"><tdclass="memSeparator"colspan="2">&#160;</td></tr>
131+
<trclass="memitem:a9bceaeb724626d1f9055e5be8ee5cc9f"><tdclass="memItemLeft"align="right"valign="top">virtual nonstd::optional&lt; std::chrono::system_clock::time_point &gt;&#160;</td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classjinja2_1_1_i_filesystem_handler.html#a9bceaeb724626d1f9055e5be8ee5cc9f">GetLastModificationDate</a> (const std::string &amp;name) const =0</td></tr>
132+
<trclass="memdesc:a9bceaeb724626d1f9055e5be8ee5cc9f"><tdclass="mdescLeft">&#160;</td><tdclass="mdescRight">Method is called to obtain the modification date of the specified file (if applicable)<ahref="classjinja2_1_1_i_filesystem_handler.html#a9bceaeb724626d1f9055e5be8ee5cc9f">More...</a><br/></td></tr>
133+
<trclass="separator:a9bceaeb724626d1f9055e5be8ee5cc9f"><tdclass="memSeparator"colspan="2">&#160;</td></tr>
125134
</table>
126-
<h2class="groupheader">Constructor &amp; Destructor Documentation</h2>
135+
<aname="details"id="details"></a><h2class="groupheader">Detailed Description</h2>
136+
<divclass="textblock"><p>Generic interface to filesystem handlers (loaders)</p>
137+
<p>This interface should be implemented in order to provide custom file system handler. Interface provides most-common methods which are called by the template environment to load the particular template.<code>OpenStream</code> methods return the unique pointer to the generic<code>istream</code> object implementation. So, the exact type (ex.<code>ifstream</code>,<code>istringstream</code> etc.) of input stream is unspecified. In order to delete stream object correctly returned pointer provide the custom deleter which should properly delete the stream object.</p>
138+
</div><h2class="groupheader">Constructor &amp; Destructor Documentation</h2>
127139
<aid="af1e98b85bed16d51148d42d64fb07e40"></a>
128140
<h2class="memtitle"><spanclass="permalink"><ahref="#af1e98b85bed16d51148d42d64fb07e40">&#9670;&nbsp;</a></span>~IFilesystemHandler()</h2>
129141

@@ -147,9 +159,49 @@ <h2 class="memtitle"><span class="permalink"><a href="#af1e98b85bed16d51148d42d6
147159
</table>
148160
</div><divclass="memdoc">
149161

162+
<p>Destructor.</p>
163+
150164
</div>
151165
</div>
152166
<h2class="groupheader">Member Function Documentation</h2>
167+
<aid="a9bceaeb724626d1f9055e5be8ee5cc9f"></a>
168+
<h2class="memtitle"><spanclass="permalink"><ahref="#a9bceaeb724626d1f9055e5be8ee5cc9f">&#9670;&nbsp;</a></span>GetLastModificationDate()</h2>
169+
170+
<divclass="memitem">
171+
<divclass="memproto">
172+
<tableclass="mlabels">
173+
<tr>
174+
<tdclass="mlabels-left">
175+
<tableclass="memname">
176+
<tr>
177+
<tdclass="memname">virtual nonstd::optional&lt;std::chrono::system_clock::time_point&gt; jinja2::IFilesystemHandler::GetLastModificationDate</td>
178+
<td>(</td>
179+
<tdclass="paramtype">const std::string &amp;&#160;</td>
180+
<tdclass="paramname"><em>name</em></td><td>)</td>
181+
<td> const</td>
182+
</tr>
183+
</table>
184+
</td>
185+
<tdclass="mlabels-right">
186+
<spanclass="mlabels"><spanclass="mlabel">pure virtual</span></span></td>
187+
</tr>
188+
</table>
189+
</div><divclass="memdoc">
190+
191+
<p>Method is called to obtain the modification date of the specified file (if applicable)</p>
192+
<p>If the underlaying filesystem supports retrival of the last modification date of the file this method should return this date when called. In other case it should return the empty optional object. Main purpose of this method is to help templates loader to determine the necessity of cached template reload</p>
193+
<dlclass="params"><dt>Parameters</dt><dd>
194+
<tableclass="params">
195+
<tr><tdclass="paramname">name</td><td>Name of the file to get the last modification date</td></tr>
196+
</table>
197+
</dd>
198+
</dl>
199+
<dlclass="section return"><dt>Returns</dt><dd>Last modification date (if applicable) or empty optional object otherwise</dd></dl>
200+
201+
<p>Implemented in<aclass="el"href="classjinja2_1_1_real_file_system.html#a5c0ceaf6dbc6dd19875107431f77e528">jinja2::RealFileSystem</a>, and<aclass="el"href="classjinja2_1_1_memory_file_system.html#aa2552ba005db25f41d4c7b3d589d3092">jinja2::MemoryFileSystem</a>.</p>
202+
203+
</div>
204+
</div>
153205
<aid="ab20beae340570f352193bd12819d8efd"></a>
154206
<h2class="memtitle"><spanclass="permalink"><ahref="#ab20beae340570f352193bd12819d8efd">&#9670;&nbsp;</a></span>OpenStream()</h2>
155207

@@ -174,6 +226,16 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab20beae340570f352193bd12
174226
</table>
175227
</div><divclass="memdoc">
176228

229+
<p>Method is called to open the file with the specified name in 'narrow-char' mode.</p>
230+
<p>Method should return unique pointer to the std::istream object with custom deleter (<aclass="el"href="namespacejinja2.html#ab5d363d70df829219a7b5652328977c6">CharFileStreamPtr</a>) . Deleter should properly delete pointee stream object.</p>
231+
<dlclass="params"><dt>Parameters</dt><dd>
232+
<tableclass="params">
233+
<tr><tdclass="paramname">name</td><td>Name of the file to open</td></tr>
234+
</table>
235+
</dd>
236+
</dl>
237+
<dlclass="section return"><dt>Returns</dt><dd>Opened stream object or empty pointer in case of any error</dd></dl>
238+
177239
<p>Implemented in<aclass="el"href="classjinja2_1_1_real_file_system.html#aa92284a328d2adfa13ef05049862b284">jinja2::RealFileSystem</a>, and<aclass="el"href="classjinja2_1_1_memory_file_system.html#aef0bb8aecde68e0aeff2e530461d39b8">jinja2::MemoryFileSystem</a>.</p>
178240

179241
</div>
@@ -202,6 +264,16 @@ <h2 class="memtitle"><span class="permalink"><a href="#a76b088ac5bcff7ecd673b45e
202264
</table>
203265
</div><divclass="memdoc">
204266

267+
<p>Method is called to open the file with the specified name in 'wide-char' mode.</p>
268+
<p>Method should return unique pointer to the std::wistream object with custom deleter (<aclass="el"href="namespacejinja2.html#ad07d25b586e095c48d73b504a49d4697">WCharFileStreamPtr</a>) . Deleter should properly delete pointee stream object.</p>
269+
<dlclass="params"><dt>Parameters</dt><dd>
270+
<tableclass="params">
271+
<tr><tdclass="paramname">name</td><td>Name of the file to open</td></tr>
272+
</table>
273+
</dd>
274+
</dl>
275+
<dlclass="section return"><dt>Returns</dt><dd>Opened stream object or empty pointer in case of any error</dd></dl>
276+
205277
<p>Implemented in<aclass="el"href="classjinja2_1_1_real_file_system.html#ae463b6ab90e75c2bd5f540347ff91f9f">jinja2::RealFileSystem</a>, and<aclass="el"href="classjinja2_1_1_memory_file_system.html#a008a9a04f0961215e0cbc5d739d2df7f">jinja2::MemoryFileSystem</a>.</p>
206278

207279
</div>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
varclassjinja2_1_1_i_filesystem_handler=
22
[
33
["~IFilesystemHandler","classjinja2_1_1_i_filesystem_handler.html#af1e98b85bed16d51148d42d64fb07e40",null],
4+
["GetLastModificationDate","classjinja2_1_1_i_filesystem_handler.html#a9bceaeb724626d1f9055e5be8ee5cc9f",null],
45
["OpenStream","classjinja2_1_1_i_filesystem_handler.html#ab20beae340570f352193bd12819d8efd",null],
56
["OpenWStream","classjinja2_1_1_i_filesystem_handler.html#a76b088ac5bcff7ecd673b45ef59906cb",null]
67
];

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp