1247738Sbapt<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2247738Sbapt<html xmlns="http://www.w3.org/1999/xhtml"> 3247738Sbapt<head> 4247738Sbapt<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5247738Sbapt<title>yaml: yaml_document_s Struct Reference</title> 6247738Sbapt<link href="tabs.css" rel="stylesheet" type="text/css"/> 7247738Sbapt<link href="doxygen.css" rel="stylesheet" type="text/css"/> 8247738Sbapt</head> 9247738Sbapt<body> 10247738Sbapt<!-- Generated by Doxygen 1.7.1 --> 11247738Sbapt<div class="navigation" id="top"> 12247738Sbapt <div class="tabs"> 13247738Sbapt <ul class="tablist"> 14247738Sbapt <li><a href="index.html"><span>Main Page</span></a></li> 15247738Sbapt <li><a href="modules.html"><span>Modules</span></a></li> 16247738Sbapt <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> 17247738Sbapt <li><a href="files.html"><span>Files</span></a></li> 18247738Sbapt </ul> 19247738Sbapt </div> 20247738Sbapt <div class="tabs2"> 21247738Sbapt <ul class="tablist"> 22247738Sbapt <li><a href="annotated.html"><span>Data Structures</span></a></li> 23247738Sbapt <li><a href="functions.html"><span>Data Fields</span></a></li> 24247738Sbapt </ul> 25247738Sbapt </div> 26247738Sbapt</div> 27247738Sbapt<div class="header"> 28247738Sbapt <div class="summary"> 29247738Sbapt<a href="#pub-attribs">Data Fields</a> </div> 30247738Sbapt <div class="headertitle"> 31247738Sbapt<h1>yaml_document_s Struct Reference<br/> 32247738Sbapt<small> 33247738Sbapt[<a class="el" href="group__nodes.html">Nodes</a>]</small> 34247738Sbapt</h1> </div> 35247738Sbapt</div> 36247738Sbapt<div class="contents"> 37247738Sbapt<!-- doxytag: class="yaml_document_s" --> 38247738Sbapt<p>The document structure. 39247738Sbapt<a href="#_details">More...</a></p> 40247738Sbapt 41247738Sbapt<p><code>#include <yaml.h></code></p> 42247738Sbapt<table class="memberdecls"> 43247738Sbapt<tr><td colspan="2"><h2><a name="pub-attribs"></a> 44247738SbaptData Fields</h2></td></tr> 45247738Sbapt<tr><td class="memItemLeft" >struct {</td></tr> 46247738Sbapt<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> 47247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The beginning of the stack. <a href="#a47c65aa6e05b1bbdd23ca6bf861057b7"></a><br/></td></tr> 48247738Sbapt<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> 49247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The end of the stack. <a href="#afbbfd5d4dcbe1f0ce088afa7266518bf"></a><br/></td></tr> 50247738Sbapt<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> 51247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The top of the stack. <a href="#a39d2f17a1edca2641a6b93646e9931b6"></a><br/></td></tr> 52247738Sbapt<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> 53247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The document nodes. <a href="#aa9eeab76b69cc84a6ab1b02c14cfd594"></a><br/></td></tr> 54247738Sbapt<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> 55247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The version directive. <a href="#a7d36862d070804b8bedb53866487ac6d"></a><br/></td></tr> 56247738Sbapt<tr><td class="memItemLeft" >struct {</td></tr> 57247738Sbapt<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> 58247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The beginning of the tag directives list. <a href="#a3f9c1d3d7466cc035179e64af2b983d5"></a><br/></td></tr> 59247738Sbapt<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> 60247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The end of the tag directives list. <a href="#aacdf541ee0945d7b3901a71538a7639f"></a><br/></td></tr> 61247738Sbapt<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> 62247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The list of tag directives. <a href="#af1e09d0469fc24106f3790b1e3de09e1"></a><br/></td></tr> 63247738Sbapt<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65c49e4f61ca5c2f6ecf410e1cc65787"></a><!-- doxytag: member="yaml_document_s::start_implicit" ref="a65c49e4f61ca5c2f6ecf410e1cc65787" args="" --> 64247738Sbaptint </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a65c49e4f61ca5c2f6ecf410e1cc65787">start_implicit</a></td></tr> 65247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Is the document start indicator implicit? <br/></td></tr> 66247738Sbapt<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59de90b4078659fd0f49377929afcac1"></a><!-- doxytag: member="yaml_document_s::end_implicit" ref="a59de90b4078659fd0f49377929afcac1" args="" --> 67247738Sbaptint </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a59de90b4078659fd0f49377929afcac1">end_implicit</a></td></tr> 68247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Is the document end indicator implicit? <br/></td></tr> 69247738Sbapt<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> 70247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The beginning of the document. <a href="#a0a37311ebf8f6637e4bc1d280a879997"></a><br/></td></tr> 71247738Sbapt<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> 72247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The end of the document. <a href="#a9299efdaadf764f4d03641a3ee51e0d0"></a><br/></td></tr> 73247738Sbapt</table> 74247738Sbapt<hr/><a name="_details"></a><h2>Detailed Description</h2> 75247738Sbapt<p>The document structure. </p> 76247738Sbapt<hr/><h2>Field Documentation</h2> 77247738Sbapt<a class="anchor" id="aa3f9a11d8fbe4ac2eada1786176bab89"></a><!-- doxytag: member="yaml_document_s::start" ref="aa3f9a11d8fbe4ac2eada1786176bab89" args="" --> 78247738Sbapt<div class="memitem"> 79247738Sbapt<div class="memproto"> 80247738Sbapt <table class="memname"> 81247738Sbapt <tr> 82247738Sbapt <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> 83247738Sbapt </tr> 84247738Sbapt </table> 85247738Sbapt</div> 86247738Sbapt<div class="memdoc"> 87247738Sbapt 88247738Sbapt<p>The beginning of the stack. </p> 89247738Sbapt 90247738Sbapt</div> 91247738Sbapt</div> 92247738Sbapt<a class="anchor" id="adc9ffcca86a2684362428da69ffd3dea"></a><!-- doxytag: member="yaml_document_s::end" ref="adc9ffcca86a2684362428da69ffd3dea" args="" --> 93247738Sbapt<div class="memitem"> 94247738Sbapt<div class="memproto"> 95247738Sbapt <table class="memname"> 96247738Sbapt <tr> 97247738Sbapt <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> 98247738Sbapt </tr> 99247738Sbapt </table> 100247738Sbapt</div> 101247738Sbapt<div class="memdoc"> 102247738Sbapt 103247738Sbapt<p>The end of the stack. </p> 104247738Sbapt 105247738Sbapt</div> 106247738Sbapt</div> 107247738Sbapt<a class="anchor" id="a5ac36f59c4a0f28124c2e1630ca4f227"></a><!-- doxytag: member="yaml_document_s::top" ref="a5ac36f59c4a0f28124c2e1630ca4f227" args="" --> 108247738Sbapt<div class="memitem"> 109247738Sbapt<div class="memproto"> 110247738Sbapt <table class="memname"> 111247738Sbapt <tr> 112247738Sbapt <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> 113247738Sbapt </tr> 114247738Sbapt </table> 115247738Sbapt</div> 116247738Sbapt<div class="memdoc"> 117247738Sbapt 118247738Sbapt<p>The top of the stack. </p> 119247738Sbapt 120247738Sbapt</div> 121247738Sbapt</div> 122247738Sbapt<a class="anchor" id="aa9eeab76b69cc84a6ab1b02c14cfd594"></a><!-- doxytag: member="yaml_document_s::nodes" ref="aa9eeab76b69cc84a6ab1b02c14cfd594" args="" --> 123247738Sbapt<div class="memitem"> 124247738Sbapt<div class="memproto"> 125247738Sbapt <table class="memname"> 126247738Sbapt <tr> 127247738Sbapt <td class="memname">struct { ... } <a class="el" href="structyaml__document__s.html#aa9eeab76b69cc84a6ab1b02c14cfd594">yaml_document_s::nodes</a></td> 128247738Sbapt </tr> 129247738Sbapt </table> 130247738Sbapt</div> 131247738Sbapt<div class="memdoc"> 132247738Sbapt 133247738Sbapt<p>The document nodes. </p> 134247738Sbapt 135247738Sbapt</div> 136247738Sbapt</div> 137247738Sbapt<a class="anchor" id="a7d36862d070804b8bedb53866487ac6d"></a><!-- doxytag: member="yaml_document_s::version_directive" ref="a7d36862d070804b8bedb53866487ac6d" args="" --> 138247738Sbapt<div class="memitem"> 139247738Sbapt<div class="memproto"> 140247738Sbapt <table class="memname"> 141247738Sbapt <tr> 142247738Sbapt <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> 143247738Sbapt </tr> 144247738Sbapt </table> 145247738Sbapt</div> 146247738Sbapt<div class="memdoc"> 147247738Sbapt 148247738Sbapt<p>The version directive. </p> 149247738Sbapt 150247738Sbapt</div> 151247738Sbapt</div> 152247738Sbapt<a class="anchor" id="afb9b6cb56a29f880ad6b76c532133c40"></a><!-- doxytag: member="yaml_document_s::start" ref="afb9b6cb56a29f880ad6b76c532133c40" args="" --> 153247738Sbapt<div class="memitem"> 154247738Sbapt<div class="memproto"> 155247738Sbapt <table class="memname"> 156247738Sbapt <tr> 157247738Sbapt <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> 158247738Sbapt </tr> 159247738Sbapt </table> 160247738Sbapt</div> 161247738Sbapt<div class="memdoc"> 162247738Sbapt 163247738Sbapt<p>The beginning of the tag directives list. </p> 164247738Sbapt 165247738Sbapt</div> 166247738Sbapt</div> 167247738Sbapt<a class="anchor" id="af14fd1a6c1fd10088391f07349ba55e8"></a><!-- doxytag: member="yaml_document_s::end" ref="af14fd1a6c1fd10088391f07349ba55e8" args="" --> 168247738Sbapt<div class="memitem"> 169247738Sbapt<div class="memproto"> 170247738Sbapt <table class="memname"> 171247738Sbapt <tr> 172247738Sbapt <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> 173247738Sbapt </tr> 174247738Sbapt </table> 175247738Sbapt</div> 176247738Sbapt<div class="memdoc"> 177247738Sbapt 178247738Sbapt<p>The end of the tag directives list. </p> 179247738Sbapt 180247738Sbapt</div> 181247738Sbapt</div> 182247738Sbapt<a class="anchor" id="af1e09d0469fc24106f3790b1e3de09e1"></a><!-- doxytag: member="yaml_document_s::tag_directives" ref="af1e09d0469fc24106f3790b1e3de09e1" args="" --> 183247738Sbapt<div class="memitem"> 184247738Sbapt<div class="memproto"> 185247738Sbapt <table class="memname"> 186247738Sbapt <tr> 187247738Sbapt <td class="memname">struct { ... } <a class="el" href="structyaml__document__s.html#af1e09d0469fc24106f3790b1e3de09e1">yaml_document_s::tag_directives</a></td> 188247738Sbapt </tr> 189247738Sbapt </table> 190247738Sbapt</div> 191247738Sbapt<div class="memdoc"> 192247738Sbapt 193247738Sbapt<p>The list of tag directives. </p> 194247738Sbapt 195247738Sbapt</div> 196247738Sbapt</div> 197247738Sbapt<a class="anchor" id="a0a37311ebf8f6637e4bc1d280a879997"></a><!-- doxytag: member="yaml_document_s::start_mark" ref="a0a37311ebf8f6637e4bc1d280a879997" args="" --> 198247738Sbapt<div class="memitem"> 199247738Sbapt<div class="memproto"> 200247738Sbapt <table class="memname"> 201247738Sbapt <tr> 202247738Sbapt <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> 203247738Sbapt </tr> 204247738Sbapt </table> 205247738Sbapt</div> 206247738Sbapt<div class="memdoc"> 207247738Sbapt 208247738Sbapt<p>The beginning of the document. </p> 209247738Sbapt 210247738Sbapt</div> 211247738Sbapt</div> 212247738Sbapt<a class="anchor" id="a9299efdaadf764f4d03641a3ee51e0d0"></a><!-- doxytag: member="yaml_document_s::end_mark" ref="a9299efdaadf764f4d03641a3ee51e0d0" args="" --> 213247738Sbapt<div class="memitem"> 214247738Sbapt<div class="memproto"> 215247738Sbapt <table class="memname"> 216247738Sbapt <tr> 217247738Sbapt <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> 218247738Sbapt </tr> 219247738Sbapt </table> 220247738Sbapt</div> 221247738Sbapt<div class="memdoc"> 222247738Sbapt 223247738Sbapt<p>The end of the document. </p> 224247738Sbapt 225247738Sbapt</div> 226247738Sbapt</div> 227247738Sbapt<hr/>The documentation for this struct was generated from the following file:<ul> 228247738Sbapt<li><a class="el" href="yaml_8h.html">yaml.h</a></li> 229247738Sbapt</ul> 230247738Sbapt</div> 231247738Sbapt<hr class="footer"/><address class="footer"><small>Generated on Mon May 30 2011 22:00:00 for yaml by 232247738Sbapt<a href="http://www.doxygen.org/index.html"> 233247738Sbapt<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address> 234247738Sbapt</body> 235247738Sbapt</html> 236
