organicmaps/pugixml
13
Fork 0
Code Issues 1 Pull requests Projects Releases Wiki Activity Actions

docs: Mention that node is a container of children in ranged for section

Browse source 
This is implicitly true due to the following section, but that was
written before C++11 so this does deserve a special mention in ranged
for section as well.

Fixes #210.
This commit is contained in:
Arseny Kapoulkine 2018-05-17 08:02:51 -07:00
parent 51322cffa1
commit e584ea337e
2 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/manual.adoc
View file

@ -1010,6 +1010,13 @@ This is an example of using these functions (link:samples/traverse_rangefor.cpp[
include::samples/traverse_rangefor.cpp[tags=code]
----
While using `children()` makes the intent of the code clear, note that each node can be treated as a container of child nodes, since it provides `begin()`/`end()` member functions described in the next section. Because of this, you can iterate through node's children simply by using the node itself:
[source]
----
for (pugi::xml_node child: tool)
----
[[access.iterators]]
=== Traversing node/attribute lists via iterators

10
docs/manual.html
View file

@ -2244,6 +2244,14 @@ If your C++ compiler supports range-based for-loop (this is a C+&#43
<span class="tok-p">}</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>While using <code>children()</code> makes the intent of the code clear, note that each node can be treated as a container of child nodes, since it provides <code>begin()</code>/<code>end()</code> member functions described in the next section. Because of this, you can iterate through node&#8217;s children simply by using the node itself:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="c++"><span class="tok-k">for</span> <span class="tok-p">(</span><span class="tok-n">pugi</span><span class="tok-o">::</span><span class="tok-n">xml_node</span> <span class="tok-nl">child</span><span class="tok-p">:</span> <span class="tok-n">tool</span><span class="tok-p">)</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="access.iterators"><a class="anchor" href="#access.iterators"></a><a class="link" href="#access.iterators">5.6. Traversing node/attribute lists via iterators</a></h3>
@ -5759,7 +5767,7 @@ If exceptions are disabled, then in the event of parsing failure the query is in
</div>
<div id="footer">
<div id="footer-text">
Last updated 2018-04-04 08:26:07 DST
Last updated 2018-05-17 08:04:31 DST
</div>
</div>
</body>