]> andersk Git - libyaml.git/blame - doc/html/structyaml__document__s.html
Imported Upstream version 0.1.2
[libyaml.git] / doc / html / structyaml__document__s.html
CommitLineData
b9668ba4 1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
5c706339 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
b9668ba4
AK
3<title>yaml: yaml_document_s Struct Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
5c706339
AK
7<!-- Generated by Doxygen 1.5.6 -->
8<div class="navigation" id="top">
9 <div class="tabs">
10 <ul>
11 <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="modules.html"><span>Modules</span></a></li>
13 <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
14 <li><a href="files.html"><span>Files</span></a></li>
15 </ul>
16 </div>
17 <div class="tabs">
18 <ul>
19 <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
20 <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
21 </ul>
22 </div>
23</div>
24<div class="contents">
b9668ba4
AK
25<h1>yaml_document_s Struct Reference<br>
26<small>
27[<a class="el" href="group__nodes.html">Nodes</a>]</small>
28</h1><!-- doxytag: class="yaml_document_s" -->The document structure.
29<a href="#_details">More...</a>
30<p>
31<code>#include &lt;yaml.h&gt;</code>
32<p>
33<table border="0" cellpadding="0" cellspacing="0">
34<tr><td></td></tr>
35<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
5c706339 36<tr><td class="memItemLeft" nowrap>struct {</td></tr>
b9668ba4
AK
37
38<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__node__s.html">yaml_node_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#a3f9a11d8fbe4ac2eada1786176bab89">start</a></td></tr>
39
5c706339 40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The beginning of the stack. <a href="#47c65aa6e05b1bbdd23ca6bf861057b7"></a><br></td></tr>
b9668ba4
AK
41<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__node__s.html">yaml_node_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#dc9ffcca86a2684362428da69ffd3dea">end</a></td></tr>
42
5c706339 43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The end of the stack. <a href="#fbbfd5d4dcbe1f0ce088afa7266518bf"></a><br></td></tr>
b9668ba4
AK
44<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__node__s.html">yaml_node_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#5ac36f59c4a0f28124c2e1630ca4f227">top</a></td></tr>
45
5c706339 46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The top of the stack. <a href="#39d2f17a1edca2641a6b93646e9931b6"></a><br></td></tr>
b9668ba4
AK
47<tr><td class="memItemLeft" nowrap valign="top">}&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a9eeab76b69cc84a6ab1b02c14cfd594">nodes</a></td></tr>
48
5c706339
AK
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The document nodes. <a href="#a9eeab76b69cc84a6ab1b02c14cfd594"></a><br></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structyaml__version__directive__s.html">yaml_version_directive_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#7d36862d070804b8bedb53866487ac6d">version_directive</a></td></tr>
b9668ba4 51
5c706339
AK
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The version directive. <a href="#7d36862d070804b8bedb53866487ac6d"></a><br></td></tr>
53<tr><td class="memItemLeft" nowrap>struct {</td></tr>
b9668ba4
AK
54
55<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#fb9b6cb56a29f880ad6b76c532133c40">start</a></td></tr>
56
5c706339 57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The beginning of the tag directives list. <a href="#3f9c1d3d7466cc035179e64af2b983d5"></a><br></td></tr>
b9668ba4
AK
58<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#f14fd1a6c1fd10088391f07349ba55e8">end</a></td></tr>
59
5c706339 60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The end of the tag directives list. <a href="#acdf541ee0945d7b3901a71538a7639f"></a><br></td></tr>
b9668ba4
AK
61<tr><td class="memItemLeft" nowrap valign="top">}&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#f1e09d0469fc24106f3790b1e3de09e1">tag_directives</a></td></tr>
62
5c706339 63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The list of tag directives. <a href="#f1e09d0469fc24106f3790b1e3de09e1"></a><br></td></tr>
b9668ba4
AK
64<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65c49e4f61ca5c2f6ecf410e1cc65787"></a><!-- doxytag: member="yaml_document_s::start_implicit" ref="65c49e4f61ca5c2f6ecf410e1cc65787" args="" -->
65int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#65c49e4f61ca5c2f6ecf410e1cc65787">start_implicit</a></td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the document start indicator implicit? <br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="59de90b4078659fd0f49377929afcac1"></a><!-- doxytag: member="yaml_document_s::end_implicit" ref="59de90b4078659fd0f49377929afcac1" args="" -->
69int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#59de90b4078659fd0f49377929afcac1">end_implicit</a></td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the document end indicator implicit? <br></td></tr>
5c706339 72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#0a37311ebf8f6637e4bc1d280a879997">start_mark</a></td></tr>
b9668ba4 73
5c706339
AK
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The beginning of the document. <a href="#0a37311ebf8f6637e4bc1d280a879997"></a><br></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#9299efdaadf764f4d03641a3ee51e0d0">end_mark</a></td></tr>
b9668ba4 76
5c706339 77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The end of the document. <a href="#9299efdaadf764f4d03641a3ee51e0d0"></a><br></td></tr>
b9668ba4
AK
78</table>
79<hr><a name="_details"></a><h2>Detailed Description</h2>
80The document structure.
81<p>
5c706339
AK
82<hr><h2>Field Documentation</h2>
83<a class="anchor" name="a3f9a11d8fbe4ac2eada1786176bab89"></a><!-- doxytag: member="yaml_document_s::start" ref="a3f9a11d8fbe4ac2eada1786176bab89" args="" -->
84<div class="memitem">
85<div class="memproto">
86 <table class="memname">
87 <tr>
88 <td class="memname"><a class="el" href="structyaml__node__s.html">yaml_node_t</a>* <a class="el" href="structyaml__document__s.html#a3f9a11d8fbe4ac2eada1786176bab89">yaml_document_s::start</a> </td>
89 </tr>
90 </table>
91</div>
92<div class="memdoc">
93
94<p>
95The beginning of the stack.
96<p>
97
98</div>
99</div><p>
100<a class="anchor" name="dc9ffcca86a2684362428da69ffd3dea"></a><!-- doxytag: member="yaml_document_s::end" ref="dc9ffcca86a2684362428da69ffd3dea" args="" -->
101<div class="memitem">
102<div class="memproto">
103 <table class="memname">
104 <tr>
105 <td class="memname"><a class="el" href="structyaml__node__s.html">yaml_node_t</a>* <a class="el" href="structyaml__document__s.html#dc9ffcca86a2684362428da69ffd3dea">yaml_document_s::end</a> </td>
106 </tr>
107 </table>
108</div>
109<div class="memdoc">
110
111<p>
112The end of the stack.
113<p>
114
115</div>
116</div><p>
117<a class="anchor" name="5ac36f59c4a0f28124c2e1630ca4f227"></a><!-- doxytag: member="yaml_document_s::top" ref="5ac36f59c4a0f28124c2e1630ca4f227" args="" -->
118<div class="memitem">
119<div class="memproto">
120 <table class="memname">
121 <tr>
122 <td class="memname"><a class="el" href="structyaml__node__s.html">yaml_node_t</a>* <a class="el" href="structyaml__document__s.html#5ac36f59c4a0f28124c2e1630ca4f227">yaml_document_s::top</a> </td>
123 </tr>
124 </table>
125</div>
126<div class="memdoc">
127
128<p>
129The top of the stack.
130<p>
131
132</div>
133</div><p>
134<a class="anchor" name="a9eeab76b69cc84a6ab1b02c14cfd594"></a><!-- doxytag: member="yaml_document_s::nodes" ref="a9eeab76b69cc84a6ab1b02c14cfd594" args="" -->
135<div class="memitem">
136<div class="memproto">
137 <table class="memname">
138 <tr>
139 <td class="memname">struct { ... } <a class="el" href="structyaml__document__s.html#a9eeab76b69cc84a6ab1b02c14cfd594">yaml_document_s::nodes</a> </td>
140 </tr>
141 </table>
142</div>
143<div class="memdoc">
144
145<p>
146The document nodes.
147<p>
148
149</div>
150</div><p>
151<a class="anchor" name="7d36862d070804b8bedb53866487ac6d"></a><!-- doxytag: member="yaml_document_s::version_directive" ref="7d36862d070804b8bedb53866487ac6d" args="" -->
152<div class="memitem">
153<div class="memproto">
154 <table class="memname">
155 <tr>
156 <td class="memname"><a class="el" href="structyaml__version__directive__s.html">yaml_version_directive_t</a>* <a class="el" href="structyaml__document__s.html#7d36862d070804b8bedb53866487ac6d">yaml_document_s::version_directive</a> </td>
157 </tr>
158 </table>
159</div>
160<div class="memdoc">
161
162<p>
163The version directive.
164<p>
165
166</div>
167</div><p>
168<a class="anchor" name="fb9b6cb56a29f880ad6b76c532133c40"></a><!-- doxytag: member="yaml_document_s::start" ref="fb9b6cb56a29f880ad6b76c532133c40" args="" -->
169<div class="memitem">
170<div class="memproto">
171 <table class="memname">
172 <tr>
173 <td class="memname"><a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a>* <a class="el" href="structyaml__document__s.html#a3f9a11d8fbe4ac2eada1786176bab89">yaml_document_s::start</a> </td>
174 </tr>
175 </table>
176</div>
177<div class="memdoc">
178
179<p>
180The beginning of the tag directives list.
181<p>
182
183</div>
184</div><p>
185<a class="anchor" name="f14fd1a6c1fd10088391f07349ba55e8"></a><!-- doxytag: member="yaml_document_s::end" ref="f14fd1a6c1fd10088391f07349ba55e8" args="" -->
186<div class="memitem">
187<div class="memproto">
188 <table class="memname">
189 <tr>
190 <td class="memname"><a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a>* <a class="el" href="structyaml__document__s.html#dc9ffcca86a2684362428da69ffd3dea">yaml_document_s::end</a> </td>
191 </tr>
192 </table>
193</div>
194<div class="memdoc">
195
196<p>
197The end of the tag directives list.
198<p>
199
200</div>
201</div><p>
202<a class="anchor" name="f1e09d0469fc24106f3790b1e3de09e1"></a><!-- doxytag: member="yaml_document_s::tag_directives" ref="f1e09d0469fc24106f3790b1e3de09e1" args="" -->
203<div class="memitem">
204<div class="memproto">
205 <table class="memname">
206 <tr>
207 <td class="memname">struct { ... } <a class="el" href="structyaml__document__s.html#f1e09d0469fc24106f3790b1e3de09e1">yaml_document_s::tag_directives</a> </td>
208 </tr>
209 </table>
210</div>
211<div class="memdoc">
212
213<p>
214The list of tag directives.
215<p>
216
217</div>
218</div><p>
219<a class="anchor" name="0a37311ebf8f6637e4bc1d280a879997"></a><!-- doxytag: member="yaml_document_s::start_mark" ref="0a37311ebf8f6637e4bc1d280a879997" args="" -->
220<div class="memitem">
221<div class="memproto">
222 <table class="memname">
223 <tr>
224 <td class="memname"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a> <a class="el" href="structyaml__document__s.html#0a37311ebf8f6637e4bc1d280a879997">yaml_document_s::start_mark</a> </td>
225 </tr>
226 </table>
227</div>
228<div class="memdoc">
229
230<p>
231The beginning of the document.
232<p>
233
234</div>
235</div><p>
236<a class="anchor" name="9299efdaadf764f4d03641a3ee51e0d0"></a><!-- doxytag: member="yaml_document_s::end_mark" ref="9299efdaadf764f4d03641a3ee51e0d0" args="" -->
237<div class="memitem">
238<div class="memproto">
239 <table class="memname">
240 <tr>
241 <td class="memname"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a> <a class="el" href="structyaml__document__s.html#9299efdaadf764f4d03641a3ee51e0d0">yaml_document_s::end_mark</a> </td>
242 </tr>
243 </table>
244</div>
245<div class="memdoc">
246
247<p>
248The end of the document.
249<p>
250
251</div>
252</div><p>
b9668ba4
AK
253<hr>The documentation for this struct was generated from the following file:<ul>
254<li><a class="el" href="yaml_8h.html">yaml.h</a></ul>
5c706339
AK
255</div>
256<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 28 01:19:28 2008 for yaml by&nbsp;
b9668ba4 257<a href="http://www.doxygen.org/index.html">
5c706339 258<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
b9668ba4
AK
259</body>
260</html>
This page took 0.079552 seconds and 5 git commands to generate.