debian-packages/dyaml
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Updated docs.

Browse source
This commit is contained in:
Ferdinand Majerech 2014-08-06 17:13:54 +02:00
parent 6ead027e51
commit d0ac642a6e
17 changed files with 19 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
autoddoc.cfg
View file

@ -29,7 +29,7 @@ links = ../index.html Documentation home
# Source files or patterns to ignore. Supports regexp syntax. # Source files or patterns to ignore. Supports regexp syntax.
# E.g; To ignore main.d and all source files in the test/ directory, # E.g; To ignore main.d and all source files in the test/ directory,
# you would use: "main.d test/*" # you would use: "main.d test/*"
ignore = test/*, examples/*, docsrc/*, autoddoc/*, yaml.d, tinyendian.d, unittest.d, cdc.d, dyaml/all.d, dyaml/composer.d, dyaml/event.d, dyaml/parser.d, dyaml/reader.d, dyaml/scanner.d, dyaml/token.d, dyaml/util.d, dyaml/anchor.d, dyaml/emitter.d, dyaml/flags.d, dyaml/serializer.d, dyaml/zerostring.d, dyaml/tag.d, dyaml/tagdirective.d, dyaml/queue.d, dyaml/escapes.d, dyaml/fastcharsearch.d, dyaml/unused.d, dyaml/streamcompat.d, dyaml/nogcutil.d, dyaml/encoding.d ignore = test/*, examples/*, docsrc/*, autoddoc/*, yaml.d, unittest.d, cdc.d, dyaml/test*, dyaml/all.d, dyaml/composer.d, dyaml/event.d, dyaml/parser.d, dyaml/reader.d, dyaml/scanner.d, dyaml/token.d, dyaml/util.d, dyaml/anchor.d, dyaml/emitter.d, dyaml/flags.d, dyaml/serializer.d, dyaml/zerostring.d, dyaml/tag.d, dyaml/tagdirective.d, dyaml/queue.d, dyaml/escapes.d, dyaml/fastcharsearch.d, dyaml/unused.d, dyaml/streamcompat.d, dyaml/nogcutil.d, dyaml/encoding.d
[DDOC] [DDOC]
# Command to use to generate the documentation. # Command to use to generate the documentation.

BIN
doc/doctrees/articles/spec_differences.doctree
View file

Binary file not shown.

BIN
doc/doctrees/environment.pickle
View file

Binary file not shown.

BIN
doc/doctrees/index.doctree
View file

Binary file not shown.

BIN
doc/doctrees/tutorials/custom_types.doctree
View file

Binary file not shown.

BIN
doc/doctrees/tutorials/getting_started.doctree
View file

Binary file not shown.

BIN
doc/doctrees/tutorials/yaml_syntax.doctree
View file

Binary file not shown.

1
doc/html/_sources/tutorials/custom_types.txt
View file

@ -202,6 +202,7 @@ Add this to your code to add implicit resolution of ``!color``.
//code from the previous example... //code from the previous example...
auto resolver = new Resolver; auto resolver = new Resolver;
import std.regex;
resolver.addImplicitResolver("!color", std.regex.regex("[0-9a-fA-F]{6}"), resolver.addImplicitResolver("!color", std.regex.regex("[0-9a-fA-F]{6}"),
"0123456789abcdefABCDEF"); "0123456789abcdefABCDEF");

12
doc/html/api/dyaml.constructor.html
View file

@ -40,9 +40,9 @@
<div id="content"> <div id="content">
<h1>dyaml.constructor</h1> <h1>dyaml.constructor</h1>
<!-- Generated by Ddoc from dyaml/constructor.d --> <!-- Generated by Ddoc from dyaml/constructor.d -->
<p>Implements a class that processes YAML mappings, sequences and scalars into <p>Class that processes YAML mappings, sequences and scalars into nodes. This can be
nodes. This can be used to implement custom data types. A tutorial can be used to add custom data types. A tutorial can be found
found <a href="../tutorials/custom_types.html">here</a>.</p> <a href="../tutorials/custom_types.html">here</a>.</p>
<dl><dt class="d_decl"><a name="Constructor"></a>class <a name="Constructor"></a><span class="ddoc_psymbol">Constructor</span>; <dl><dt class="d_decl"><a name="Constructor"></a>class <a name="Constructor"></a><span class="ddoc_psymbol">Constructor</span>;
</dt> </dt>
@ -254,17 +254,17 @@ MyStruct constructMyStructMapping(<span class="d_keyword">ref</span> Node node)
</dd> </dd>
</dl> </dl>
</dd> </dd>
<dt class="d_decl"><a name="constructNull"></a>YAMLNull <a name="constructNull"></a><span class="ddoc_psymbol">constructNull</span>(ref Node <b>node</b>); <dt class="d_decl"><a name="constructNull"></a>pure nothrow @nogc @safe YAMLNull <a name="constructNull"></a><span class="ddoc_psymbol">constructNull</span>(ref Node <b>node</b>);
</dt> </dt>
<dd><p>Construct a null node.</p> <dd><p>Construct a null node.</p>
</dd> </dd>
<dt class="d_decl"><a name="constructMerge"></a>YAMLMerge <a name="constructMerge"></a><span class="ddoc_psymbol">constructMerge</span>(ref Node <b>node</b>); <dt class="d_decl"><a name="constructMerge"></a>pure nothrow @nogc @safe YAMLMerge <a name="constructMerge"></a><span class="ddoc_psymbol">constructMerge</span>(ref Node <b>node</b>);
</dt> </dt>
<dd><p>Construct a merge node - a node that merges another node into a mapping.</p> <dd><p>Construct a merge node - a node that merges another node into a mapping.</p>
</dd> </dd>
<dt class="d_decl"><a name="constructBool"></a>bool <a name="constructBool"></a><span class="ddoc_psymbol">constructBool</span>(ref Node <b>node</b>); <dt class="d_decl"><a name="constructBool"></a>@safe bool <a name="constructBool"></a><span class="ddoc_psymbol">constructBool</span>(ref Node <b>node</b>);
</dt> </dt>
<dd><p>Construct a boolean node.</p> <dd><p>Construct a boolean node.</p>

5
doc/html/api/dyaml.loader.html
View file

@ -153,8 +153,9 @@ loader.resolver = resolver;
loaded to memory or a string with YAML data. Note that loaded to memory or a string with YAML data. Note that
buffer <b>will</b> be overwritten, as D:YAML minimizes buffer <b>will</b> be overwritten, as D:YAML minimizes
memory allocations by reusing the input buffer. memory allocations by reusing the input buffer.
<br> <b>Must not be deleted or modified by the user as long
as nodes loaded by this Loader are in use!</b> - Nodes may
refer to data in this buffer.
<br> <br>
Note that D:YAML looks for byte-order-marks YAML files encoded in Note that D:YAML looks for byte-order-marks YAML files encoded in

2
doc/html/articles/spec_differences.html
View file

@ -139,7 +139,7 @@ struct appears in Phobos.</p>
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2011-2014, Ferdinand Majerech. Based on PyYAML http://www.pyyaml.org by Kirill Simonov. &copy; Copyright 2011-2014, Ferdinand Majerech. Based on PyYAML http://www.pyyaml.org by Kirill Simonov.
Last updated on Aug 01, 2014. Last updated on Aug 06, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div> </div>
</body> </body>

2
doc/html/index.html
View file

@ -105,7 +105,7 @@
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2011-2014, Ferdinand Majerech. Based on PyYAML http://www.pyyaml.org by Kirill Simonov. &copy; Copyright 2011-2014, Ferdinand Majerech. Based on PyYAML http://www.pyyaml.org by Kirill Simonov.
Last updated on Aug 01, 2014. Last updated on Aug 06, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div> </div>
</body> </body>

2
doc/html/search.html
View file

@ -90,7 +90,7 @@
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2011-2014, Ferdinand Majerech. Based on PyYAML http://www.pyyaml.org by Kirill Simonov. &copy; Copyright 2011-2014, Ferdinand Majerech. Based on PyYAML http://www.pyyaml.org by Kirill Simonov.
Last updated on Aug 01, 2014. Last updated on Aug 06, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div> </div>
</body> </body>

2
doc/html/searchindex.js
View file

File diff suppressed because one or more lines are too long

3
doc/html/tutorials/custom_types.html
View file

@ -221,6 +221,7 @@ be resolvable as any non-string YAML data type.</p>
<div class="highlight-d"><div class="highlight"><pre><span class="c1">//code from the previous example...</span> <div class="highlight-d"><div class="highlight"><pre><span class="c1">//code from the previous example...</span>
<span class="k">auto</span> <span class="n">resolver</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Resolver</span><span class="p">;</span> <span class="k">auto</span> <span class="n">resolver</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Resolver</span><span class="p">;</span>
<span class="k">import</span> <span class="n">std</span><span class="p">.</span><span class="n">regex</span><span class="p">;</span>
<span class="n">resolver</span><span class="p">.</span><span class="n">addImplicitResolver</span><span class="p">(</span><span class="s">&quot;!color&quot;</span><span class="p">,</span> <span class="n">std</span><span class="p">.</span><span class="n">regex</span><span class="p">.</span><span class="n">regex</span><span class="p">(</span><span class="s">&quot;[0-9a-fA-F]{6}&quot;</span><span class="p">),</span> <span class="n">resolver</span><span class="p">.</span><span class="n">addImplicitResolver</span><span class="p">(</span><span class="s">&quot;!color&quot;</span><span class="p">,</span> <span class="n">std</span><span class="p">.</span><span class="n">regex</span><span class="p">.</span><span class="n">regex</span><span class="p">(</span><span class="s">&quot;[0-9a-fA-F]{6}&quot;</span><span class="p">),</span>
<span class="s">&quot;0123456789abcdefABCDEF&quot;</span><span class="p">);</span> <span class="s">&quot;0123456789abcdefABCDEF&quot;</span><span class="p">);</span>
@ -377,7 +378,7 @@ directory of the D:YAML package.</p>
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2011-2014, Ferdinand Majerech. Based on PyYAML http://www.pyyaml.org by Kirill Simonov. &copy; Copyright 2011-2014, Ferdinand Majerech. Based on PyYAML http://www.pyyaml.org by Kirill Simonov.
Last updated on Aug 01, 2014. Last updated on Aug 06, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div> </div>
</body> </body>

2
doc/html/tutorials/getting_started.html
View file

@ -234,7 +234,7 @@ example in the <tt class="docutils literal"><span class="pre">example/getting_st
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2011-2014, Ferdinand Majerech. Based on PyYAML http://www.pyyaml.org by Kirill Simonov. &copy; Copyright 2011-2014, Ferdinand Majerech. Based on PyYAML http://www.pyyaml.org by Kirill Simonov.
Last updated on Aug 01, 2014. Last updated on Aug 06, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div> </div>
</body> </body>

2
doc/html/tutorials/yaml_syntax.html
View file

@ -331,7 +331,7 @@ Some of these might change in the future (especially !!map and !!set).</p>
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2011-2014, Ferdinand Majerech. Based on PyYAML http://www.pyyaml.org by Kirill Simonov. &copy; Copyright 2011-2014, Ferdinand Majerech. Based on PyYAML http://www.pyyaml.org by Kirill Simonov.
Last updated on Aug 01, 2014. Last updated on Aug 06, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div> </div>
</body> </body>