Update documentation

phonetic__run_8hpp_source.html

@@ -66,9 +66,9 @@
 <div class="title">phonetic_run.hpp</div>  </div>
 </div><!--header-->
 <div class="contents">
-<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">// Copyright (c) 2016-2020</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">// in the Software without restriction, including without limitation the rights</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">// copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">// furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">// The above copyright notice and this permission notice shall be included in</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">// all copies or substantial portions of the Software.</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">// THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">// THE SOFTWARE</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">// @license: http://www.opensource.org/licenses/mit-license.php</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">// @author: see AUTHORS file</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#include &lt;xlnt/xlnt_config.hpp&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacexlnt.html">xlnt</a> {</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structxlnt_1_1phonetic__run.html">   35</a></span>&#160;<span class="keyword">struct </span>XLNT_API <a class="code" href="structxlnt_1_1phonetic__run.html">phonetic_run</a></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;{</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    std::string text;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    uint32_t start;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    uint32_t end;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <span class="keywordtype">bool</span> preserve_space;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="namespacexlnt.html#a87898d966ebb2cf7326f2ef778daad96">operator==</a>(<span class="keyword">const</span> <a class="code" href="structxlnt_1_1phonetic__run.html">phonetic_run</a> &amp;other) <span class="keyword">const</span>;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="namespacexlnt.html#a2148ce62721952a2b26ce9791d1856b7">operator!=</a>(<span class="keyword">const</span> <a class="code" href="structxlnt_1_1phonetic__run.html">phonetic_run</a> &amp;other) <span class="keyword">const</span>;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;};</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;} <span class="comment">// namespace xlnt</span></div><div class="ttc" id="namespacexlnt_html"><div class="ttname"><a href="namespacexlnt.html">xlnt</a></div><div class="ttdoc">Enumerates the possible types a cell can be determined by it&amp;#39;s current value. </div><div class="ttdef"><b>Definition:</b> cell.hpp:36</div></div>
+<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">// Copyright (c) 2016-2020</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">// in the Software without restriction, including without limitation the rights</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">// copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">// furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">// The above copyright notice and this permission notice shall be included in</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">// all copies or substantial portions of the Software.</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">// THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">// THE SOFTWARE</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">// @license: http://www.opensource.org/licenses/mit-license.php</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">// @author: see AUTHORS file</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#include &lt;xlnt/xlnt_config.hpp&gt;</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacexlnt.html">xlnt</a> {</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structxlnt_1_1phonetic__run.html">   36</a></span>&#160;<span class="keyword">struct </span>XLNT_API <a class="code" href="structxlnt_1_1phonetic__run.html">phonetic_run</a></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;{</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    std::string text;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    uint32_t start;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    uint32_t end;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    <span class="keywordtype">bool</span> preserve_space;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="namespacexlnt.html#a87898d966ebb2cf7326f2ef778daad96">operator==</a>(<span class="keyword">const</span> <a class="code" href="structxlnt_1_1phonetic__run.html">phonetic_run</a> &amp;other) <span class="keyword">const</span>;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="namespacexlnt.html#a2148ce62721952a2b26ce9791d1856b7">operator!=</a>(<span class="keyword">const</span> <a class="code" href="structxlnt_1_1phonetic__run.html">phonetic_run</a> &amp;other) <span class="keyword">const</span>;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;};</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;} <span class="comment">// namespace xlnt</span></div><div class="ttc" id="namespacexlnt_html"><div class="ttname"><a href="namespacexlnt.html">xlnt</a></div><div class="ttdoc">Enumerates the possible types a cell can be determined by it&amp;#39;s current value. </div><div class="ttdef"><b>Definition:</b> cell.hpp:36</div></div>
 <div class="ttc" id="namespacexlnt_html_a87898d966ebb2cf7326f2ef778daad96"><div class="ttname"><a href="namespacexlnt.html#a87898d966ebb2cf7326f2ef778daad96">xlnt::operator==</a></div><div class="ttdeci">bool operator==(std::nullptr_t, const cell &amp;cell)</div><div class="ttdoc">Returns true if this cell is uninitialized. </div></div>
-<div class="ttc" id="structxlnt_1_1phonetic__run_html"><div class="ttname"><a href="structxlnt_1_1phonetic__run.html">xlnt::phonetic_run</a></div><div class="ttdoc">Encapsulates a run of text that </div><div class="ttdef"><b>Definition:</b> phonetic_run.hpp:35</div></div>
+<div class="ttc" id="structxlnt_1_1phonetic__run_html"><div class="ttname"><a href="structxlnt_1_1phonetic__run.html">xlnt::phonetic_run</a></div><div class="ttdoc">Encapsulates a run of text that </div><div class="ttdef"><b>Definition:</b> phonetic_run.hpp:36</div></div>
 <div class="ttc" id="namespacexlnt_html_a2148ce62721952a2b26ce9791d1856b7"><div class="ttname"><a href="namespacexlnt.html#a2148ce62721952a2b26ce9791d1856b7">xlnt::operator!=</a></div><div class="ttdeci">bool operator!=(const std::string &amp;reference_string, const range_reference &amp;ref)</div><div class="ttdoc">Returns true if the string representation of the range is not equivalent to ref. </div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->

rich__text_8hpp_source.html

@@ -72,7 +72,7 @@
 <div class="ttc" id="classxlnt_1_1font_html"><div class="ttname"><a href="classxlnt_1_1font.html">xlnt::font</a></div><div class="ttdoc">Describes the font style of a particular cell. </div><div class="ttdef"><b>Definition:</b> font.hpp:40</div></div>
 <div class="ttc" id="namespacexlnt_html_a87898d966ebb2cf7326f2ef778daad96"><div class="ttname"><a href="namespacexlnt.html#a87898d966ebb2cf7326f2ef778daad96">xlnt::operator==</a></div><div class="ttdeci">bool operator==(std::nullptr_t, const cell &amp;cell)</div><div class="ttdoc">Returns true if this cell is uninitialized. </div></div>
 <div class="ttc" id="classxlnt_1_1rich__text_html"><div class="ttname"><a href="classxlnt_1_1rich__text.html">xlnt::rich_text</a></div><div class="ttdoc">Encapsulates zero or more formatted text runs where a text run is a string of text with the same defi...</div><div class="ttdef"><b>Definition:</b> rich_text.hpp:40</div></div>
-<div class="ttc" id="structxlnt_1_1phonetic__run_html"><div class="ttname"><a href="structxlnt_1_1phonetic__run.html">xlnt::phonetic_run</a></div><div class="ttdoc">Encapsulates a run of text that </div><div class="ttdef"><b>Definition:</b> phonetic_run.hpp:35</div></div>
+<div class="ttc" id="structxlnt_1_1phonetic__run_html"><div class="ttname"><a href="structxlnt_1_1phonetic__run.html">xlnt::phonetic_run</a></div><div class="ttdoc">Encapsulates a run of text that </div><div class="ttdef"><b>Definition:</b> phonetic_run.hpp:36</div></div>
 <div class="ttc" id="classxlnt_1_1optional_html"><div class="ttname"><a href="classxlnt_1_1optional.html">xlnt::optional</a></div><div class="ttdoc">Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may ...</div><div class="ttdef"><b>Definition:</b> format.hpp:43</div></div>
 <div class="ttc" id="classxlnt_1_1rich__text__hash_html"><div class="ttname"><a href="classxlnt_1_1rich__text__hash.html">xlnt::rich_text_hash</a></div><div class="ttdef"><b>Definition:</b> rich_text.hpp:163</div></div>
 <div class="ttc" id="namespacexlnt_html_a2148ce62721952a2b26ce9791d1856b7"><div class="ttname"><a href="namespacexlnt.html#a2148ce62721952a2b26ce9791d1856b7">xlnt::operator!=</a></div><div class="ttdeci">bool operator!=(const std::string &amp;reference_string, const range_reference &amp;ref)</div><div class="ttdoc">Returns true if the string representation of the range is not equivalent to ref. </div></div>