]>
Commit | Line | Data |
---|---|---|
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"/> | |
b9668ba4 | 5 | <title>yaml: yaml_document_s Struct Reference</title> |
0fbeb4dc AK |
6 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
7 | <link href="doxygen.css" rel="stylesheet" type="text/css"/> | |
8 | </head> | |
9 | <body> | |
10 | <!-- Generated by Doxygen 1.7.1 --> | |
5c706339 AK |
11 | <div class="navigation" id="top"> |
12 | <div class="tabs"> | |
0fbeb4dc | 13 | <ul class="tablist"> |
5c706339 AK |
14 | <li><a href="index.html"><span>Main Page</span></a></li> |
15 | <li><a href="modules.html"><span>Modules</span></a></li> | |
16 | <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> | |
17 | <li><a href="files.html"><span>Files</span></a></li> | |
18 | </ul> | |
19 | </div> | |
0fbeb4dc AK |
20 | <div class="tabs2"> |
21 | <ul class="tablist"> | |
5c706339 AK |
22 | <li><a href="annotated.html"><span>Data Structures</span></a></li> |
23 | <li><a href="functions.html"><span>Data Fields</span></a></li> | |
24 | </ul> | |
25 | </div> | |
26 | </div> | |
0fbeb4dc AK |
27 | <div class="header"> |
28 | <div class="summary"> | |
29 | <a href="#pub-attribs">Data Fields</a> </div> | |
30 | <div class="headertitle"> | |
31 | <h1>yaml_document_s Struct Reference<br/> | |
b9668ba4 AK |
32 | <small> |
33 | [<a class="el" href="group__nodes.html">Nodes</a>]</small> | |
0fbeb4dc AK |
34 | </h1> </div> |
35 | </div> | |
36 | <div class="contents"> | |
37 | <!-- doxytag: class="yaml_document_s" --> | |
38 | <p>The document structure. | |
39 | <a href="#_details">More...</a></p> | |
40 | ||
41 | <p><code>#include <yaml.h></code></p> | |
42 | <table class="memberdecls"> | |
43 | <tr><td colspan="2"><h2><a name="pub-attribs"></a> | |
44 | Data Fields</h2></td></tr> | |
45 | <tr><td class="memItemLeft" >struct {</td></tr> | |
46 | <tr><td class="memItemLeft" > <a class="el" href="structyaml__node__s.html">yaml_node_t</a> * <a class="el" href="structyaml__document__s.html#aa3f9a11d8fbe4ac2eada1786176bab89">start</a></td></tr> | |
47 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The beginning of the stack. <a href="#a47c65aa6e05b1bbdd23ca6bf861057b7"></a><br/></td></tr> | |
48 | <tr><td class="memItemLeft" > <a class="el" href="structyaml__node__s.html">yaml_node_t</a> * <a class="el" href="structyaml__document__s.html#adc9ffcca86a2684362428da69ffd3dea">end</a></td></tr> | |
49 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The end of the stack. <a href="#afbbfd5d4dcbe1f0ce088afa7266518bf"></a><br/></td></tr> | |
50 | <tr><td class="memItemLeft" > <a class="el" href="structyaml__node__s.html">yaml_node_t</a> * <a class="el" href="structyaml__document__s.html#a5ac36f59c4a0f28124c2e1630ca4f227">top</a></td></tr> | |
51 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The top of the stack. <a href="#a39d2f17a1edca2641a6b93646e9931b6"></a><br/></td></tr> | |
52 | <tr><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#aa9eeab76b69cc84a6ab1b02c14cfd594">nodes</a></td></tr> | |
53 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The document nodes. <a href="#aa9eeab76b69cc84a6ab1b02c14cfd594"></a><br/></td></tr> | |
54 | <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structyaml__version__directive__s.html">yaml_version_directive_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a7d36862d070804b8bedb53866487ac6d">version_directive</a></td></tr> | |
55 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The version directive. <a href="#a7d36862d070804b8bedb53866487ac6d"></a><br/></td></tr> | |
56 | <tr><td class="memItemLeft" >struct {</td></tr> | |
57 | <tr><td class="memItemLeft" > <a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> * <a class="el" href="structyaml__document__s.html#afb9b6cb56a29f880ad6b76c532133c40">start</a></td></tr> | |
58 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The beginning of the tag directives list. <a href="#a3f9c1d3d7466cc035179e64af2b983d5"></a><br/></td></tr> | |
59 | <tr><td class="memItemLeft" > <a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> * <a class="el" href="structyaml__document__s.html#af14fd1a6c1fd10088391f07349ba55e8">end</a></td></tr> | |
60 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The end of the tag directives list. <a href="#aacdf541ee0945d7b3901a71538a7639f"></a><br/></td></tr> | |
61 | <tr><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#af1e09d0469fc24106f3790b1e3de09e1">tag_directives</a></td></tr> | |
62 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The list of tag directives. <a href="#af1e09d0469fc24106f3790b1e3de09e1"></a><br/></td></tr> | |
63 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65c49e4f61ca5c2f6ecf410e1cc65787"></a><!-- doxytag: member="yaml_document_s::start_implicit" ref="a65c49e4f61ca5c2f6ecf410e1cc65787" args="" --> | |
64 | int </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a65c49e4f61ca5c2f6ecf410e1cc65787">start_implicit</a></td></tr> | |
65 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Is the document start indicator implicit? <br/></td></tr> | |
66 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59de90b4078659fd0f49377929afcac1"></a><!-- doxytag: member="yaml_document_s::end_implicit" ref="a59de90b4078659fd0f49377929afcac1" args="" --> | |
67 | int </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a59de90b4078659fd0f49377929afcac1">end_implicit</a></td></tr> | |
68 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Is the document end indicator implicit? <br/></td></tr> | |
69 | <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a0a37311ebf8f6637e4bc1d280a879997">start_mark</a></td></tr> | |
70 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The beginning of the document. <a href="#a0a37311ebf8f6637e4bc1d280a879997"></a><br/></td></tr> | |
71 | <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a9299efdaadf764f4d03641a3ee51e0d0">end_mark</a></td></tr> | |
72 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The end of the document. <a href="#a9299efdaadf764f4d03641a3ee51e0d0"></a><br/></td></tr> | |
b9668ba4 | 73 | </table> |
0fbeb4dc AK |
74 | <hr/><a name="_details"></a><h2>Detailed Description</h2> |
75 | <p>The document structure. </p> | |
76 | <hr/><h2>Field Documentation</h2> | |
77 | <a class="anchor" id="aa3f9a11d8fbe4ac2eada1786176bab89"></a><!-- doxytag: member="yaml_document_s::start" ref="aa3f9a11d8fbe4ac2eada1786176bab89" args="" --> | |
5c706339 AK |
78 | <div class="memitem"> |
79 | <div class="memproto"> | |
80 | <table class="memname"> | |
81 | <tr> | |
0fbeb4dc | 82 | <td class="memname"><a class="el" href="structyaml__node__s.html">yaml_node_t</a>* <a class="el" href="structyaml__document__s.html#aa3f9a11d8fbe4ac2eada1786176bab89">yaml_document_s::start</a></td> |
5c706339 AK |
83 | </tr> |
84 | </table> | |
85 | </div> | |
86 | <div class="memdoc"> | |
87 | ||
0fbeb4dc | 88 | <p>The beginning of the stack. </p> |
5c706339 AK |
89 | |
90 | </div> | |
0fbeb4dc AK |
91 | </div> |
92 | <a class="anchor" id="adc9ffcca86a2684362428da69ffd3dea"></a><!-- doxytag: member="yaml_document_s::end" ref="adc9ffcca86a2684362428da69ffd3dea" args="" --> | |
5c706339 AK |
93 | <div class="memitem"> |
94 | <div class="memproto"> | |
95 | <table class="memname"> | |
96 | <tr> | |
0fbeb4dc | 97 | <td class="memname"><a class="el" href="structyaml__node__s.html">yaml_node_t</a>* <a class="el" href="structyaml__document__s.html#adc9ffcca86a2684362428da69ffd3dea">yaml_document_s::end</a></td> |
5c706339 AK |
98 | </tr> |
99 | </table> | |
100 | </div> | |
101 | <div class="memdoc"> | |
102 | ||
0fbeb4dc | 103 | <p>The end of the stack. </p> |
5c706339 AK |
104 | |
105 | </div> | |
0fbeb4dc AK |
106 | </div> |
107 | <a class="anchor" id="a5ac36f59c4a0f28124c2e1630ca4f227"></a><!-- doxytag: member="yaml_document_s::top" ref="a5ac36f59c4a0f28124c2e1630ca4f227" args="" --> | |
5c706339 AK |
108 | <div class="memitem"> |
109 | <div class="memproto"> | |
110 | <table class="memname"> | |
111 | <tr> | |
0fbeb4dc | 112 | <td class="memname"><a class="el" href="structyaml__node__s.html">yaml_node_t</a>* <a class="el" href="structyaml__document__s.html#a5ac36f59c4a0f28124c2e1630ca4f227">yaml_document_s::top</a></td> |
5c706339 AK |
113 | </tr> |
114 | </table> | |
115 | </div> | |
116 | <div class="memdoc"> | |
117 | ||
0fbeb4dc | 118 | <p>The top of the stack. </p> |
5c706339 AK |
119 | |
120 | </div> | |
0fbeb4dc AK |
121 | </div> |
122 | <a class="anchor" id="aa9eeab76b69cc84a6ab1b02c14cfd594"></a><!-- doxytag: member="yaml_document_s::nodes" ref="aa9eeab76b69cc84a6ab1b02c14cfd594" args="" --> | |
5c706339 AK |
123 | <div class="memitem"> |
124 | <div class="memproto"> | |
125 | <table class="memname"> | |
126 | <tr> | |
0fbeb4dc | 127 | <td class="memname">struct { ... } <a class="el" href="structyaml__document__s.html#aa9eeab76b69cc84a6ab1b02c14cfd594">yaml_document_s::nodes</a></td> |
5c706339 AK |
128 | </tr> |
129 | </table> | |
130 | </div> | |
131 | <div class="memdoc"> | |
132 | ||
0fbeb4dc | 133 | <p>The document nodes. </p> |
5c706339 AK |
134 | |
135 | </div> | |
0fbeb4dc AK |
136 | </div> |
137 | <a class="anchor" id="a7d36862d070804b8bedb53866487ac6d"></a><!-- doxytag: member="yaml_document_s::version_directive" ref="a7d36862d070804b8bedb53866487ac6d" args="" --> | |
5c706339 AK |
138 | <div class="memitem"> |
139 | <div class="memproto"> | |
140 | <table class="memname"> | |
141 | <tr> | |
0fbeb4dc | 142 | <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#a7d36862d070804b8bedb53866487ac6d">yaml_document_s::version_directive</a></td> |
5c706339 AK |
143 | </tr> |
144 | </table> | |
145 | </div> | |
146 | <div class="memdoc"> | |
147 | ||
0fbeb4dc | 148 | <p>The version directive. </p> |
5c706339 AK |
149 | |
150 | </div> | |
0fbeb4dc AK |
151 | </div> |
152 | <a class="anchor" id="afb9b6cb56a29f880ad6b76c532133c40"></a><!-- doxytag: member="yaml_document_s::start" ref="afb9b6cb56a29f880ad6b76c532133c40" args="" --> | |
5c706339 AK |
153 | <div class="memitem"> |
154 | <div class="memproto"> | |
155 | <table class="memname"> | |
156 | <tr> | |
0fbeb4dc | 157 | <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#aa3f9a11d8fbe4ac2eada1786176bab89">yaml_document_s::start</a></td> |
5c706339 AK |
158 | </tr> |
159 | </table> | |
160 | </div> | |
161 | <div class="memdoc"> | |
162 | ||
0fbeb4dc | 163 | <p>The beginning of the tag directives list. </p> |
5c706339 AK |
164 | |
165 | </div> | |
0fbeb4dc AK |
166 | </div> |
167 | <a class="anchor" id="af14fd1a6c1fd10088391f07349ba55e8"></a><!-- doxytag: member="yaml_document_s::end" ref="af14fd1a6c1fd10088391f07349ba55e8" args="" --> | |
5c706339 AK |
168 | <div class="memitem"> |
169 | <div class="memproto"> | |
170 | <table class="memname"> | |
171 | <tr> | |
0fbeb4dc | 172 | <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#adc9ffcca86a2684362428da69ffd3dea">yaml_document_s::end</a></td> |
5c706339 AK |
173 | </tr> |
174 | </table> | |
175 | </div> | |
176 | <div class="memdoc"> | |
177 | ||
0fbeb4dc | 178 | <p>The end of the tag directives list. </p> |
5c706339 AK |
179 | |
180 | </div> | |
0fbeb4dc AK |
181 | </div> |
182 | <a class="anchor" id="af1e09d0469fc24106f3790b1e3de09e1"></a><!-- doxytag: member="yaml_document_s::tag_directives" ref="af1e09d0469fc24106f3790b1e3de09e1" args="" --> | |
5c706339 AK |
183 | <div class="memitem"> |
184 | <div class="memproto"> | |
185 | <table class="memname"> | |
186 | <tr> | |
0fbeb4dc | 187 | <td class="memname">struct { ... } <a class="el" href="structyaml__document__s.html#af1e09d0469fc24106f3790b1e3de09e1">yaml_document_s::tag_directives</a></td> |
5c706339 AK |
188 | </tr> |
189 | </table> | |
190 | </div> | |
191 | <div class="memdoc"> | |
192 | ||
0fbeb4dc | 193 | <p>The list of tag directives. </p> |
5c706339 AK |
194 | |
195 | </div> | |
0fbeb4dc AK |
196 | </div> |
197 | <a class="anchor" id="a0a37311ebf8f6637e4bc1d280a879997"></a><!-- doxytag: member="yaml_document_s::start_mark" ref="a0a37311ebf8f6637e4bc1d280a879997" args="" --> | |
5c706339 AK |
198 | <div class="memitem"> |
199 | <div class="memproto"> | |
200 | <table class="memname"> | |
201 | <tr> | |
0fbeb4dc | 202 | <td class="memname"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a> <a class="el" href="structyaml__document__s.html#a0a37311ebf8f6637e4bc1d280a879997">yaml_document_s::start_mark</a></td> |
5c706339 AK |
203 | </tr> |
204 | </table> | |
205 | </div> | |
206 | <div class="memdoc"> | |
207 | ||
0fbeb4dc | 208 | <p>The beginning of the document. </p> |
5c706339 AK |
209 | |
210 | </div> | |
0fbeb4dc AK |
211 | </div> |
212 | <a class="anchor" id="a9299efdaadf764f4d03641a3ee51e0d0"></a><!-- doxytag: member="yaml_document_s::end_mark" ref="a9299efdaadf764f4d03641a3ee51e0d0" args="" --> | |
5c706339 AK |
213 | <div class="memitem"> |
214 | <div class="memproto"> | |
215 | <table class="memname"> | |
216 | <tr> | |
0fbeb4dc | 217 | <td class="memname"><a class="el" href="structyaml__mark__s.html">yaml_mark_t</a> <a class="el" href="structyaml__document__s.html#a9299efdaadf764f4d03641a3ee51e0d0">yaml_document_s::end_mark</a></td> |
5c706339 AK |
218 | </tr> |
219 | </table> | |
220 | </div> | |
221 | <div class="memdoc"> | |
222 | ||
0fbeb4dc | 223 | <p>The end of the document. </p> |
5c706339 AK |
224 | |
225 | </div> | |
5c706339 | 226 | </div> |
0fbeb4dc AK |
227 | <hr/>The documentation for this struct was generated from the following file:<ul> |
228 | <li><a class="el" href="yaml_8h.html">yaml.h</a></li> | |
229 | </ul> | |
230 | </div> | |
231 | <hr class="footer"/><address class="footer"><small>Generated on Mon May 30 2011 22:00:00 for yaml by | |
b9668ba4 | 232 | <a href="http://www.doxygen.org/index.html"> |
0fbeb4dc | 233 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address> |
b9668ba4 AK |
234 | </body> |
235 | </html> |