<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>yaml: yaml_document_s Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<h1>yaml_document_s Struct Reference<br/>
<small>
[<a class="el" href="group__nodes.html">Nodes</a>]</small>
</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="yaml_document_s" -->
<p>The document structure.
<a href="#_details">More...</a></p>
<p><code>#include <yaml.h></code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" >struct {</td></tr>
<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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The beginning of the stack. <a href="#a47c65aa6e05b1bbdd23ca6bf861057b7"></a><br/></td></tr>
<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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The end of the stack. <a href="#afbbfd5d4dcbe1f0ce088afa7266518bf"></a><br/></td></tr>
<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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The top of the stack. <a href="#a39d2f17a1edca2641a6b93646e9931b6"></a><br/></td></tr>
<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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The document nodes. <a href="#aa9eeab76b69cc84a6ab1b02c14cfd594"></a><br/></td></tr>
<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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The version directive. <a href="#a7d36862d070804b8bedb53866487ac6d"></a><br/></td></tr>
<tr><td class="memItemLeft" >struct {</td></tr>
<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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The beginning of the tag directives list. <a href="#a3f9c1d3d7466cc035179e64af2b983d5"></a><br/></td></tr>
<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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The end of the tag directives list. <a href="#aacdf541ee0945d7b3901a71538a7639f"></a><br/></td></tr>
<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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The list of tag directives. <a href="#af1e09d0469fc24106f3790b1e3de09e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65c49e4f61ca5c2f6ecf410e1cc65787"></a><!-- doxytag: member="yaml_document_s::start_implicit" ref="a65c49e4f61ca5c2f6ecf410e1cc65787" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a65c49e4f61ca5c2f6ecf410e1cc65787">start_implicit</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Is the document start indicator implicit? <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59de90b4078659fd0f49377929afcac1"></a><!-- doxytag: member="yaml_document_s::end_implicit" ref="a59de90b4078659fd0f49377929afcac1" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a59de90b4078659fd0f49377929afcac1">end_implicit</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Is the document end indicator implicit? <br/></td></tr>
<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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The beginning of the document. <a href="#a0a37311ebf8f6637e4bc1d280a879997"></a><br/></td></tr>
<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>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The end of the document. <a href="#a9299efdaadf764f4d03641a3ee51e0d0"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The document structure. </p>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="aa3f9a11d8fbe4ac2eada1786176bab89"></a><!-- doxytag: member="yaml_document_s::start" ref="aa3f9a11d8fbe4ac2eada1786176bab89" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div>
<div class="memdoc">
<p>The beginning of the stack. </p>
</div>
</div>
<a class="anchor" id="adc9ffcca86a2684362428da69ffd3dea"></a><!-- doxytag: member="yaml_document_s::end" ref="adc9ffcca86a2684362428da69ffd3dea" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div>
<div class="memdoc">
<p>The end of the stack. </p>
</div>
</div>
<a class="anchor" id="a5ac36f59c4a0f28124c2e1630ca4f227"></a><!-- doxytag: member="yaml_document_s::top" ref="a5ac36f59c4a0f28124c2e1630ca4f227" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div>
<div class="memdoc">
<p>The top of the stack. </p>
</div>
</div>
<a class="anchor" id="aa9eeab76b69cc84a6ab1b02c14cfd594"></a><!-- doxytag: member="yaml_document_s::nodes" ref="aa9eeab76b69cc84a6ab1b02c14cfd594" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct { ... } <a class="el" href="structyaml__document__s.html#aa9eeab76b69cc84a6ab1b02c14cfd594">yaml_document_s::nodes</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The document nodes. </p>
</div>
</div>
<a class="anchor" id="a7d36862d070804b8bedb53866487ac6d"></a><!-- doxytag: member="yaml_document_s::version_directive" ref="a7d36862d070804b8bedb53866487ac6d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div>
<div class="memdoc">
<p>The version directive. </p>
</div>
</div>
<a class="anchor" id="afb9b6cb56a29f880ad6b76c532133c40"></a><!-- doxytag: member="yaml_document_s::start" ref="afb9b6cb56a29f880ad6b76c532133c40" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div>
<div class="memdoc">
<p>The beginning of the tag directives list. </p>
</div>
</div>
<a class="anchor" id="af14fd1a6c1fd10088391f07349ba55e8"></a><!-- doxytag: member="yaml_document_s::end" ref="af14fd1a6c1fd10088391f07349ba55e8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div>
<div class="memdoc">
<p>The end of the tag directives list. </p>
</div>
</div>
<a class="anchor" id="af1e09d0469fc24106f3790b1e3de09e1"></a><!-- doxytag: member="yaml_document_s::tag_directives" ref="af1e09d0469fc24106f3790b1e3de09e1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct { ... } <a class="el" href="structyaml__document__s.html#af1e09d0469fc24106f3790b1e3de09e1">yaml_document_s::tag_directives</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The list of tag directives. </p>
</div>
</div>
<a class="anchor" id="a0a37311ebf8f6637e4bc1d280a879997"></a><!-- doxytag: member="yaml_document_s::start_mark" ref="a0a37311ebf8f6637e4bc1d280a879997" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div>
<div class="memdoc">
<p>The beginning of the document. </p>
</div>
</div>
<a class="anchor" id="a9299efdaadf764f4d03641a3ee51e0d0"></a><!-- doxytag: member="yaml_document_s::end_mark" ref="a9299efdaadf764f4d03641a3ee51e0d0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div>
<div class="memdoc">
<p>The end of the document. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="yaml_8h.html">yaml.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon May 30 2011 22:00:00 for yaml by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
| Name | Type | Size | Permission | Actions |
|---|---|---|---|---|
| annotated.html | File | 3.38 KB | 0644 |
|
| bc_s.png | File | 677 B | 0644 |
|
| classes.html | File | 2.93 KB | 0644 |
|
| closed.png | File | 126 B | 0644 |
|
| doxygen.css | File | 9.58 KB | 0644 |
|
| doxygen.png | File | 3.85 KB | 0644 |
|
| files.html | File | 1.59 KB | 0644 |
|
| functions.html | File | 4.47 KB | 0644 |
|
| functions_0x62.html | File | 3.97 KB | 0644 |
|
| functions_0x63.html | File | 4.06 KB | 0644 |
|
| functions_0x64.html | File | 4.02 KB | 0644 |
|
| functions_0x65.html | File | 6.17 KB | 0644 |
|
| functions_0x66.html | File | 3.82 KB | 0644 |
|
| functions_0x68.html | File | 3.92 KB | 0644 |
|
| functions_0x69.html | File | 4.37 KB | 0644 |
|
| functions_0x6b.html | File | 3.37 KB | 0644 |
|
| functions_0x6c.html | File | 4.34 KB | 0644 |
|
| functions_0x6d.html | File | 4.65 KB | 0644 |
|
| functions_0x6e.html | File | 3.37 KB | 0644 |
|
| functions_0x6f.html | File | 3.73 KB | 0644 |
|
| functions_0x70.html | File | 4.85 KB | 0644 |
|
| functions_0x71.html | File | 3.38 KB | 0644 |
|
| functions_0x72.html | File | 4.1 KB | 0644 |
|
| functions_0x73.html | File | 8.45 KB | 0644 |
|
| functions_0x74.html | File | 6.13 KB | 0644 |
|
| functions_0x75.html | File | 3.37 KB | 0644 |
|
| functions_0x76.html | File | 4.09 KB | 0644 |
|
| functions_0x77.html | File | 3.63 KB | 0644 |
|
| functions_vars.html | File | 4.48 KB | 0644 |
|
| functions_vars_0x62.html | File | 3.98 KB | 0644 |
|
| functions_vars_0x63.html | File | 4.07 KB | 0644 |
|
| functions_vars_0x64.html | File | 4.03 KB | 0644 |
|
| functions_vars_0x65.html | File | 6.17 KB | 0644 |
|
| functions_vars_0x66.html | File | 3.83 KB | 0644 |
|
| functions_vars_0x68.html | File | 3.93 KB | 0644 |
|
| functions_vars_0x69.html | File | 4.38 KB | 0644 |
|
| functions_vars_0x6b.html | File | 3.38 KB | 0644 |
|
| functions_vars_0x6c.html | File | 4.34 KB | 0644 |
|
| functions_vars_0x6d.html | File | 4.66 KB | 0644 |
|
| functions_vars_0x6e.html | File | 3.38 KB | 0644 |
|
| functions_vars_0x6f.html | File | 3.73 KB | 0644 |
|
| functions_vars_0x70.html | File | 4.86 KB | 0644 |
|
| functions_vars_0x71.html | File | 3.38 KB | 0644 |
|
| functions_vars_0x72.html | File | 4.1 KB | 0644 |
|
| functions_vars_0x73.html | File | 8.46 KB | 0644 |
|
| functions_vars_0x74.html | File | 6.13 KB | 0644 |
|
| functions_vars_0x75.html | File | 3.38 KB | 0644 |
|
| functions_vars_0x76.html | File | 4.1 KB | 0644 |
|
| functions_vars_0x77.html | File | 3.64 KB | 0644 |
|
| globals.html | File | 30.29 KB | 0644 |
|
| globals_defs.html | File | 3.13 KB | 0644 |
|
| globals_enum.html | File | 3.04 KB | 0644 |
|
| globals_eval.html | File | 18.64 KB | 0644 |
|
| globals_func.html | File | 7.85 KB | 0644 |
|
| globals_type.html | File | 4.83 KB | 0644 |
|
| group__basic.html | File | 20.41 KB | 0644 |
|
| group__emitter.html | File | 48.02 KB | 0644 |
|
| group__events.html | File | 38.43 KB | 0644 |
|
| group__export.html | File | 2.36 KB | 0644 |
|
| group__nodes.html | File | 43.98 KB | 0644 |
|
| group__parser.html | File | 42.82 KB | 0644 |
|
| group__styles.html | File | 13.58 KB | 0644 |
|
| group__tokens.html | File | 17.05 KB | 0644 |
|
| group__version.html | File | 4.61 KB | 0644 |
|
| index.html | File | 1.21 KB | 0644 |
|
| modules.html | File | 1.79 KB | 0644 |
|
| nav_f.png | File | 159 B | 0644 |
|
| nav_h.png | File | 97 B | 0644 |
|
| open.png | File | 118 B | 0644 |
|
| structyaml__alias__data__s.html | File | 4.92 KB | 0644 |
|
| structyaml__document__s.html | File | 12.6 KB | 0644 |
|
| structyaml__emitter__s.html | File | 86.48 KB | 0644 |
|
| structyaml__event__s.html | File | 28.71 KB | 0644 |
|
| structyaml__mark__s.html | File | 4.56 KB | 0644 |
|
| structyaml__node__pair__s.html | File | 3.8 KB | 0644 |
|
| structyaml__node__s.html | File | 22.16 KB | 0644 |
|
| structyaml__parser__s.html | File | 77.49 KB | 0644 |
|
| structyaml__simple__key__s.html | File | 4.97 KB | 0644 |
|
| structyaml__tag__directive__s.html | File | 4.16 KB | 0644 |
|
| structyaml__token__s.html | File | 22.11 KB | 0644 |
|
| structyaml__version__directive__s.html | File | 3.9 KB | 0644 |
|
| tab_a.png | File | 140 B | 0644 |
|
| tab_b.png | File | 178 B | 0644 |
|
| tab_h.png | File | 192 B | 0644 |
|
| tab_s.png | File | 189 B | 0644 |
|
| tabs.css | File | 1.07 KB | 0644 |
|
| yaml_8h.html | File | 72.53 KB | 0644 |
|
