source: trunk/packages/libyaml/doc/html/structyaml__document__s.html @ 998

Last change on this file since 998 was 898, checked in by hartmans, 16 years ago

Add pyyaml and libyaml packages
backported from lenny.
There is discussion about how these should go in the repository; these are added in this form
in order to make forward progress.

File size: 7.1 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>yaml: yaml_document_s Struct Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.1 -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li id="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13    <li><a href="files.html"><span>Files</span></a></li>
14  </ul></div>
15<div class="tabs">
16  <ul>
17    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
18    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
19  </ul></div>
20<h1>yaml_document_s Struct Reference<br>
21<small>
22[<a class="el" href="group__nodes.html">Nodes</a>]</small>
23</h1><!-- doxytag: class="yaml_document_s" -->The document structure. 
24<a href="#_details">More...</a>
25<p>
26<code>#include &lt;yaml.h&gt;</code>
27<p>
28<table border="0" cellpadding="0" cellspacing="0">
29<tr><td></td></tr>
30<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
31<tr><td class="memItemLeft" nowrap><a class="anchor" name="a9eeab76b69cc84a6ab1b02c14cfd594"></a><!-- doxytag: member="yaml_document_s::nodes" ref="a9eeab76b69cc84a6ab1b02c14cfd594" args="" -->
32struct {</td></tr>
33
34<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__node__s.html">yaml_node_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#a3f9a11d8fbe4ac2eada1786176bab89">start</a></td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The beginning of the stack. <br></td></tr>
37<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__node__s.html">yaml_node_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#dc9ffcca86a2684362428da69ffd3dea">end</a></td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The end of the stack. <br></td></tr>
40<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__node__s.html">yaml_node_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#5ac36f59c4a0f28124c2e1630ca4f227">top</a></td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The top of the stack. <br></td></tr>
43<tr><td class="memItemLeft" nowrap valign="top">}&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#a9eeab76b69cc84a6ab1b02c14cfd594">nodes</a></td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The document nodes. <br></td></tr>
46<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d36862d070804b8bedb53866487ac6d"></a><!-- doxytag: member="yaml_document_s::version_directive" ref="7d36862d070804b8bedb53866487ac6d" args="" -->
47<a class="el" href="structyaml__version__directive__s.html">yaml_version_directive_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#7d36862d070804b8bedb53866487ac6d">version_directive</a></td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The version directive. <br></td></tr>
50<tr><td class="memItemLeft" nowrap><a class="anchor" name="f1e09d0469fc24106f3790b1e3de09e1"></a><!-- doxytag: member="yaml_document_s::tag_directives" ref="f1e09d0469fc24106f3790b1e3de09e1" args="" -->
51struct {</td></tr>
52
53<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#fb9b6cb56a29f880ad6b76c532133c40">start</a></td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The beginning of the tag directives list. <br></td></tr>
56<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> *&nbsp;&nbsp;&nbsp;<a class="el" href="structyaml__document__s.html#f14fd1a6c1fd10088391f07349ba55e8">end</a></td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The end of the tag directives list. <br></td></tr>
59<tr><td class="memItemLeft" nowrap valign="top">}&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#f1e09d0469fc24106f3790b1e3de09e1">tag_directives</a></td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The list of tag directives. <br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65c49e4f61ca5c2f6ecf410e1cc65787"></a><!-- doxytag: member="yaml_document_s::start_implicit" ref="65c49e4f61ca5c2f6ecf410e1cc65787" args="" -->
63int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#65c49e4f61ca5c2f6ecf410e1cc65787">start_implicit</a></td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the document start indicator implicit? <br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="59de90b4078659fd0f49377929afcac1"></a><!-- doxytag: member="yaml_document_s::end_implicit" ref="59de90b4078659fd0f49377929afcac1" args="" -->
67int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#59de90b4078659fd0f49377929afcac1">end_implicit</a></td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the document end indicator implicit? <br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a37311ebf8f6637e4bc1d280a879997"></a><!-- doxytag: member="yaml_document_s::start_mark" ref="0a37311ebf8f6637e4bc1d280a879997" args="" -->
71<a class="el" href="structyaml__mark__s.html">yaml_mark_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#0a37311ebf8f6637e4bc1d280a879997">start_mark</a></td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The beginning of the document. <br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9299efdaadf764f4d03641a3ee51e0d0"></a><!-- doxytag: member="yaml_document_s::end_mark" ref="9299efdaadf764f4d03641a3ee51e0d0" args="" -->
75<a class="el" href="structyaml__mark__s.html">yaml_mark_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html#9299efdaadf764f4d03641a3ee51e0d0">end_mark</a></td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The end of the document. <br></td></tr>
78</table>
79<hr><a name="_details"></a><h2>Detailed Description</h2>
80The document structure.
81<p>
82<hr>The documentation for this struct was generated from the following file:<ul>
83<li><a class="el" href="yaml_8h.html">yaml.h</a></ul>
84<hr size="1"><address style="align: right;"><small>Generated on Thu May 31 22:50:59 2007 for yaml by&nbsp;
85<a href="http://www.doxygen.org/index.html">
86<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
87</body>
88</html>
Note: See TracBrowser for help on using the repository browser.