]> andersk Git - libyaml.git/blame - doc/html/structyaml__document__s.html
Update upstream source from tag 'upstream/0.2.2'
[libyaml.git] / doc / html / structyaml__document__s.html
CommitLineData
0fbeb4dc
AK
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
059850b5 5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
c45550e5
AK
6<meta name="generator" content="Doxygen 1.8.14"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
b9668ba4 8<title>yaml: yaml_document_s Struct Reference</title>
0fbeb4dc 9<link href="tabs.css" rel="stylesheet" type="text/css"/>
0044e680
AK
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
059850b5 12<link href="doxygen.css" rel="stylesheet" type="text/css" />
0fbeb4dc
AK
13</head>
14<body>
0044e680 15<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
059850b5
AK
16<div id="titlearea">
17<table cellspacing="0" cellpadding="0">
18 <tbody>
19 <tr style="height: 56px;">
c45550e5 20 <td id="projectalign" style="padding-left: 0.5em;">
059850b5 21 <div id="projectname">yaml
5070705b 22 &#160;<span id="projectnumber">0.2.2</span>
059850b5 23 </div>
059850b5 24 </td>
059850b5
AK
25 </tr>
26 </tbody>
27</table>
28</div>
0044e680 29<!-- end header part -->
c45550e5
AK
30<!-- Generated by Doxygen 1.8.14 -->
31<script type="text/javascript" src="menudata.js"></script>
32<script type="text/javascript" src="menu.js"></script>
33<script type="text/javascript">
34/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35$(function() {
36 initMenu('',false,false,'search.php','Search');
37});
38/* @license-end */</script>
39<div id="main-nav"></div>
0044e680 40</div><!-- top -->
0fbeb4dc
AK
41<div class="header">
42 <div class="summary">
43<a href="#pub-attribs">Data Fields</a> </div>
44 <div class="headertitle">
059850b5
AK
45<div class="title">yaml_document_s Struct Reference<div class="ingroups"><a class="el" href="group__nodes.html">Nodes</a></div></div> </div>
46</div><!--header-->
0fbeb4dc 47<div class="contents">
0044e680 48
0fbeb4dc 49<p>The document structure.
059850b5 50 <a href="structyaml__document__s.html#details">More...</a></p>
0fbeb4dc
AK
51
52<p><code>#include &lt;yaml.h&gt;</code></p>
53<table class="memberdecls">
0044e680 54<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
0fbeb4dc 55Data Fields</h2></td></tr>
0044e680
AK
56<tr class="memitem:aa9eeab76b69cc84a6ab1b02c14cfd594"><td class="memItemLeft" >struct {</td></tr>
57<tr class="memitem:a47c65aa6e05b1bbdd23ca6bf861057b7"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a> *&#160;&#160;&#160;<a class="el" href="structyaml__document__s.html#aa3f9a11d8fbe4ac2eada1786176bab89">start</a></td></tr>
c45550e5 58<tr class="memdesc:a47c65aa6e05b1bbdd23ca6bf861057b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The beginning of the stack. <a href="#a47c65aa6e05b1bbdd23ca6bf861057b7">More...</a><br /></td></tr>
0044e680
AK
59<tr class="separator:a47c65aa6e05b1bbdd23ca6bf861057b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
60<tr class="memitem:afbbfd5d4dcbe1f0ce088afa7266518bf"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a> *&#160;&#160;&#160;<a class="el" href="structyaml__document__s.html#adc9ffcca86a2684362428da69ffd3dea">end</a></td></tr>
c45550e5 61<tr class="memdesc:afbbfd5d4dcbe1f0ce088afa7266518bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">The end of the stack. <a href="#afbbfd5d4dcbe1f0ce088afa7266518bf">More...</a><br /></td></tr>
0044e680
AK
62<tr class="separator:afbbfd5d4dcbe1f0ce088afa7266518bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
63<tr class="memitem:a39d2f17a1edca2641a6b93646e9931b6"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a> *&#160;&#160;&#160;<a class="el" href="structyaml__document__s.html#a5ac36f59c4a0f28124c2e1630ca4f227">top</a></td></tr>
c45550e5 64<tr class="memdesc:a39d2f17a1edca2641a6b93646e9931b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The top of the stack. <a href="#a39d2f17a1edca2641a6b93646e9931b6">More...</a><br /></td></tr>
0044e680
AK
65<tr class="separator:a39d2f17a1edca2641a6b93646e9931b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
66<tr class="memitem:aa9eeab76b69cc84a6ab1b02c14cfd594"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#aa9eeab76b69cc84a6ab1b02c14cfd594">nodes</a></td></tr>
c45550e5 67<tr class="memdesc:aa9eeab76b69cc84a6ab1b02c14cfd594"><td class="mdescLeft">&#160;</td><td class="mdescRight">The document nodes. <a href="#aa9eeab76b69cc84a6ab1b02c14cfd594">More...</a><br /></td></tr>
0044e680
AK
68<tr class="separator:aa9eeab76b69cc84a6ab1b02c14cfd594"><td class="memSeparator" colspan="2">&#160;</td></tr>
69<tr class="memitem:a7d36862d070804b8bedb53866487ac6d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a7d36862d070804b8bedb53866487ac6d">version_directive</a></td></tr>
c45550e5 70<tr class="memdesc:a7d36862d070804b8bedb53866487ac6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The version directive. <a href="#a7d36862d070804b8bedb53866487ac6d">More...</a><br /></td></tr>
0044e680
AK
71<tr class="separator:a7d36862d070804b8bedb53866487ac6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
72<tr class="memitem:af1e09d0469fc24106f3790b1e3de09e1"><td class="memItemLeft" >struct {</td></tr>
73<tr class="memitem:a3f9c1d3d7466cc035179e64af2b983d5"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *&#160;&#160;&#160;<a class="el" href="structyaml__document__s.html#afb9b6cb56a29f880ad6b76c532133c40">start</a></td></tr>
c45550e5 74<tr class="memdesc:a3f9c1d3d7466cc035179e64af2b983d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The beginning of the tag directives list. <a href="#a3f9c1d3d7466cc035179e64af2b983d5">More...</a><br /></td></tr>
0044e680
AK
75<tr class="separator:a3f9c1d3d7466cc035179e64af2b983d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
76<tr class="memitem:aacdf541ee0945d7b3901a71538a7639f"><td class="memItemLeft" >&#160;&#160;&#160;<a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *&#160;&#160;&#160;<a class="el" href="structyaml__document__s.html#af14fd1a6c1fd10088391f07349ba55e8">end</a></td></tr>
c45550e5 77<tr class="memdesc:aacdf541ee0945d7b3901a71538a7639f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The end of the tag directives list. <a href="#aacdf541ee0945d7b3901a71538a7639f">More...</a><br /></td></tr>
0044e680
AK
78<tr class="separator:aacdf541ee0945d7b3901a71538a7639f"><td class="memSeparator" colspan="2">&#160;</td></tr>
79<tr class="memitem:af1e09d0469fc24106f3790b1e3de09e1"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#af1e09d0469fc24106f3790b1e3de09e1">tag_directives</a></td></tr>
c45550e5 80<tr class="memdesc:af1e09d0469fc24106f3790b1e3de09e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of tag directives. <a href="#af1e09d0469fc24106f3790b1e3de09e1">More...</a><br /></td></tr>
0044e680 81<tr class="separator:af1e09d0469fc24106f3790b1e3de09e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
c45550e5 82<tr class="memitem:a65c49e4f61ca5c2f6ecf410e1cc65787"><td class="memItemLeft" align="right" valign="top"><a id="a65c49e4f61ca5c2f6ecf410e1cc65787"></a>
059850b5 83int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a65c49e4f61ca5c2f6ecf410e1cc65787">start_implicit</a></td></tr>
c45550e5 84<tr class="memdesc:a65c49e4f61ca5c2f6ecf410e1cc65787"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the document start indicator implicit? <br /></td></tr>
0044e680 85<tr class="separator:a65c49e4f61ca5c2f6ecf410e1cc65787"><td class="memSeparator" colspan="2">&#160;</td></tr>
c45550e5 86<tr class="memitem:a59de90b4078659fd0f49377929afcac1"><td class="memItemLeft" align="right" valign="top"><a id="a59de90b4078659fd0f49377929afcac1"></a>
059850b5 87int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a59de90b4078659fd0f49377929afcac1">end_implicit</a></td></tr>
c45550e5 88<tr class="memdesc:a59de90b4078659fd0f49377929afcac1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the document end indicator implicit? <br /></td></tr>
0044e680
AK
89<tr class="separator:a59de90b4078659fd0f49377929afcac1"><td class="memSeparator" colspan="2">&#160;</td></tr>
90<tr class="memitem:a0a37311ebf8f6637e4bc1d280a879997"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__basic.html#ga232eacba89691b841ba941338a302bfd">yaml_mark_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a0a37311ebf8f6637e4bc1d280a879997">start_mark</a></td></tr>
c45550e5 91<tr class="memdesc:a0a37311ebf8f6637e4bc1d280a879997"><td class="mdescLeft">&#160;</td><td class="mdescRight">The beginning of the document. <a href="#a0a37311ebf8f6637e4bc1d280a879997">More...</a><br /></td></tr>
0044e680
AK
92<tr class="separator:a0a37311ebf8f6637e4bc1d280a879997"><td class="memSeparator" colspan="2">&#160;</td></tr>
93<tr class="memitem:a9299efdaadf764f4d03641a3ee51e0d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__basic.html#ga232eacba89691b841ba941338a302bfd">yaml_mark_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a9299efdaadf764f4d03641a3ee51e0d0">end_mark</a></td></tr>
c45550e5 94<tr class="memdesc:a9299efdaadf764f4d03641a3ee51e0d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The end of the document. <a href="#a9299efdaadf764f4d03641a3ee51e0d0">More...</a><br /></td></tr>
0044e680 95<tr class="separator:a9299efdaadf764f4d03641a3ee51e0d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
b9668ba4 96</table>
0044e680 97<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
059850b5 98<div class="textblock"><p>The document structure. </p>
0044e680 99</div><h2 class="groupheader">Field Documentation</h2>
c45550e5
AK
100<a id="aa3f9a11d8fbe4ac2eada1786176bab89"></a>
101<h2 class="memtitle"><span class="permalink"><a href="#aa3f9a11d8fbe4ac2eada1786176bab89">&#9670;&nbsp;</a></span>start <span class="overload">[1/2]</span></h2>
102
5c706339
AK
103<div class="memitem">
104<div class="memproto">
105 <table class="memname">
106 <tr>
0044e680 107 <td class="memname"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a>* yaml_document_s::start</td>
5c706339
AK
108 </tr>
109 </table>
0044e680 110</div><div class="memdoc">
5c706339 111
0fbeb4dc 112<p>The beginning of the stack. </p>
5c706339
AK
113
114</div>
0fbeb4dc 115</div>
c45550e5
AK
116<a id="adc9ffcca86a2684362428da69ffd3dea"></a>
117<h2 class="memtitle"><span class="permalink"><a href="#adc9ffcca86a2684362428da69ffd3dea">&#9670;&nbsp;</a></span>end <span class="overload">[1/2]</span></h2>
118
5c706339
AK
119<div class="memitem">
120<div class="memproto">
121 <table class="memname">
122 <tr>
0044e680 123 <td class="memname"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a>* yaml_document_s::end</td>
5c706339
AK
124 </tr>
125 </table>
0044e680 126</div><div class="memdoc">
5c706339 127
0fbeb4dc 128<p>The end of the stack. </p>
5c706339
AK
129
130</div>
0fbeb4dc 131</div>
c45550e5
AK
132<a id="a5ac36f59c4a0f28124c2e1630ca4f227"></a>
133<h2 class="memtitle"><span class="permalink"><a href="#a5ac36f59c4a0f28124c2e1630ca4f227">&#9670;&nbsp;</a></span>top</h2>
134
5c706339
AK
135<div class="memitem">
136<div class="memproto">
137 <table class="memname">
138 <tr>
0044e680 139 <td class="memname"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a>* yaml_document_s::top</td>
5c706339
AK
140 </tr>
141 </table>
0044e680 142</div><div class="memdoc">
5c706339 143
0fbeb4dc 144<p>The top of the stack. </p>
5c706339
AK
145
146</div>
0fbeb4dc 147</div>
c45550e5
AK
148<a id="aa9eeab76b69cc84a6ab1b02c14cfd594"></a>
149<h2 class="memtitle"><span class="permalink"><a href="#aa9eeab76b69cc84a6ab1b02c14cfd594">&#9670;&nbsp;</a></span>nodes</h2>
150
5c706339
AK
151<div class="memitem">
152<div class="memproto">
153 <table class="memname">
154 <tr>
0044e680 155 <td class="memname">struct { ... } yaml_document_s::nodes</td>
5c706339
AK
156 </tr>
157 </table>
0044e680 158</div><div class="memdoc">
5c706339 159
0fbeb4dc 160<p>The document nodes. </p>
5c706339
AK
161
162</div>
0fbeb4dc 163</div>
c45550e5
AK
164<a id="a7d36862d070804b8bedb53866487ac6d"></a>
165<h2 class="memtitle"><span class="permalink"><a href="#a7d36862d070804b8bedb53866487ac6d">&#9670;&nbsp;</a></span>version_directive</h2>
166
5c706339
AK
167<div class="memitem">
168<div class="memproto">
169 <table class="memname">
170 <tr>
0044e680 171 <td class="memname"><a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a>* yaml_document_s::version_directive</td>
5c706339
AK
172 </tr>
173 </table>
0044e680 174</div><div class="memdoc">
5c706339 175
0fbeb4dc 176<p>The version directive. </p>
5c706339
AK
177
178</div>
0fbeb4dc 179</div>
c45550e5
AK
180<a id="afb9b6cb56a29f880ad6b76c532133c40"></a>
181<h2 class="memtitle"><span class="permalink"><a href="#afb9b6cb56a29f880ad6b76c532133c40">&#9670;&nbsp;</a></span>start <span class="overload">[2/2]</span></h2>
182
5c706339
AK
183<div class="memitem">
184<div class="memproto">
185 <table class="memname">
186 <tr>
0044e680 187 <td class="memname"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a>* yaml_document_s::start</td>
5c706339
AK
188 </tr>
189 </table>
0044e680 190</div><div class="memdoc">
5c706339 191
0fbeb4dc 192<p>The beginning of the tag directives list. </p>
5c706339
AK
193
194</div>
0fbeb4dc 195</div>
c45550e5
AK
196<a id="af14fd1a6c1fd10088391f07349ba55e8"></a>
197<h2 class="memtitle"><span class="permalink"><a href="#af14fd1a6c1fd10088391f07349ba55e8">&#9670;&nbsp;</a></span>end <span class="overload">[2/2]</span></h2>
198
5c706339
AK
199<div class="memitem">
200<div class="memproto">
201 <table class="memname">
202 <tr>
0044e680 203 <td class="memname"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a>* yaml_document_s::end</td>
5c706339
AK
204 </tr>
205 </table>
0044e680 206</div><div class="memdoc">
5c706339 207
0fbeb4dc 208<p>The end of the tag directives list. </p>
5c706339
AK
209
210</div>
0fbeb4dc 211</div>
c45550e5
AK
212<a id="af1e09d0469fc24106f3790b1e3de09e1"></a>
213<h2 class="memtitle"><span class="permalink"><a href="#af1e09d0469fc24106f3790b1e3de09e1">&#9670;&nbsp;</a></span>tag_directives</h2>
214
5c706339
AK
215<div class="memitem">
216<div class="memproto">
217 <table class="memname">
218 <tr>
0044e680 219 <td class="memname">struct { ... } yaml_document_s::tag_directives</td>
5c706339
AK
220 </tr>
221 </table>
0044e680 222</div><div class="memdoc">
5c706339 223
0fbeb4dc 224<p>The list of tag directives. </p>
5c706339
AK
225
226</div>
0fbeb4dc 227</div>
c45550e5
AK
228<a id="a0a37311ebf8f6637e4bc1d280a879997"></a>
229<h2 class="memtitle"><span class="permalink"><a href="#a0a37311ebf8f6637e4bc1d280a879997">&#9670;&nbsp;</a></span>start_mark</h2>
230
5c706339
AK
231<div class="memitem">
232<div class="memproto">
233 <table class="memname">
234 <tr>
0044e680 235 <td class="memname"><a class="el" href="group__basic.html#ga232eacba89691b841ba941338a302bfd">yaml_mark_t</a> yaml_document_s::start_mark</td>
5c706339
AK
236 </tr>
237 </table>
0044e680 238</div><div class="memdoc">
5c706339 239
0fbeb4dc 240<p>The beginning of the document. </p>
5c706339
AK
241
242</div>
0fbeb4dc 243</div>
c45550e5
AK
244<a id="a9299efdaadf764f4d03641a3ee51e0d0"></a>
245<h2 class="memtitle"><span class="permalink"><a href="#a9299efdaadf764f4d03641a3ee51e0d0">&#9670;&nbsp;</a></span>end_mark</h2>
246
5c706339
AK
247<div class="memitem">
248<div class="memproto">
249 <table class="memname">
250 <tr>
0044e680 251 <td class="memname"><a class="el" href="group__basic.html#ga232eacba89691b841ba941338a302bfd">yaml_mark_t</a> yaml_document_s::end_mark</td>
5c706339
AK
252 </tr>
253 </table>
0044e680 254</div><div class="memdoc">
5c706339 255
0fbeb4dc 256<p>The end of the document. </p>
5c706339
AK
257
258</div>
5c706339 259</div>
0fbeb4dc
AK
260<hr/>The documentation for this struct was generated from the following file:<ul>
261<li><a class="el" href="yaml_8h.html">yaml.h</a></li>
262</ul>
059850b5 263</div><!-- contents -->
0044e680 264<!-- start footer part -->
059850b5 265<hr class="footer"/><address class="footer"><small>
c45550e5 266Generated by &#160;<a href="http://www.doxygen.org/index.html">
059850b5 267<img class="footer" src="doxygen.png" alt="doxygen"/>
c45550e5 268</a> 1.8.14
059850b5 269</small></address>
b9668ba4
AK
270</body>
271</html>
This page took 0.10132 seconds and 5 git commands to generate.