doc/html/structyaml__document__s.html

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