Skip to content

Commit

Permalink
docs: regenerate doxygen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bxparks committed Dec 14, 2024
1 parent a844b67 commit f16adde
Show file tree
Hide file tree
Showing 466 changed files with 76,080 additions and 75,766 deletions.
91 changes: 46 additions & 45 deletions docs/html/AceTime_8h_source.html

Large diffs are not rendered by default.

1,318 changes: 657 additions & 661 deletions docs/html/BasicZoneProcessor_8h_source.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/html/BasicZone_8cpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">AceTime
&#160;<span id="projectnumber">2.3.0</span>
&#160;<span id="projectnumber">2.4.0</span>
</div>
<div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database.</div>
</td>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/BasicZone_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">AceTime
&#160;<span id="projectnumber">2.3.0</span>
&#160;<span id="projectnumber">2.4.0</span>
</div>
<div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database.</div>
</td>
Expand Down Expand Up @@ -144,7 +144,7 @@
<div class="ttc" id="aclassace__time_1_1zoneinfolow_1_1ZoneContextBroker_html"><div class="ttname"><a href="classace__time_1_1zoneinfolow_1_1ZoneContextBroker.html">ace_time::zoneinfolow::ZoneContextBroker</a></div><div class="ttdoc">Data broker for accessing a ZoneContext.</div><div class="ttdef"><b>Definition:</b> <a href="BrokersLow_8h_source.html#l00091">BrokersLow.h:91</a></div></div>
<div class="ttc" id="aclassace__time_1_1zoneinfolow_1_1ZoneEraBroker_html"><div class="ttname"><a href="classace__time_1_1zoneinfolow_1_1ZoneEraBroker.html">ace_time::zoneinfolow::ZoneEraBroker</a></div><div class="ttdoc">Data broker for accessing ZoneEra.</div><div class="ttdef"><b>Definition:</b> <a href="BrokersLow_8h_source.html#l00297">BrokersLow.h:297</a></div></div>
<div class="ttc" id="aclassace__time_1_1zoneinfolow_1_1ZoneInfoBroker_html"><div class="ttname"><a href="classace__time_1_1zoneinfolow_1_1ZoneInfoBroker.html">ace_time::zoneinfolow::ZoneInfoBroker&lt; ZoneContext, ZoneInfo, ZoneEra, ZonePolicy, ZoneRule &gt;</a></div></div>
<div class="ttc" id="astructace__time_1_1zoneinfolow_1_1ZoneInfo_html"><div class="ttname"><a href="structace__time_1_1zoneinfolow_1_1ZoneInfo.html">ace_time::zoneinfolow::ZoneInfo</a></div><div class="ttdoc">Representation of a given time zone, implemented as an array of ZoneEra records.</div><div class="ttdef"><b>Definition:</b> <a href="ZoneInfoLow_8h_source.html#l00302">ZoneInfoLow.h:302</a></div></div>
<div class="ttc" id="astructace__time_1_1zoneinfolow_1_1ZoneInfo_html"><div class="ttname"><a href="structace__time_1_1zoneinfolow_1_1ZoneInfo.html">ace_time::zoneinfolow::ZoneInfo</a></div><div class="ttdoc">Representation of a given time zone, implemented as an array of ZoneEra records.</div><div class="ttdef"><b>Definition:</b> <a href="ZoneInfoLow_8h_source.html#l00320">ZoneInfoLow.h:320</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/BrokerCommon_8cpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">AceTime
&#160;<span id="projectnumber">2.3.0</span>
&#160;<span id="projectnumber">2.4.0</span>
</div>
<div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database.</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/BrokerCommon_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">AceTime
&#160;<span id="projectnumber">2.3.0</span>
&#160;<span id="projectnumber">2.4.0</span>
</div>
<div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database.</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/BrokerCommon_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">AceTime
&#160;<span id="projectnumber">2.3.0</span>
&#160;<span id="projectnumber">2.4.0</span>
</div>
<div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database.</div>
</td>
Expand Down
10 changes: 5 additions & 5 deletions docs/html/BrokersHigh_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">AceTime
&#160;<span id="projectnumber">2.3.0</span>
&#160;<span id="projectnumber">2.4.0</span>
</div>
<div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database.</div>
</td>
Expand Down Expand Up @@ -75,14 +75,14 @@
</div><!--header-->
<div class="contents">

<p>These classes provide a thin layer of indirection for accessing the data structures defined by <code><a class="el" href="ZoneInfoHigh_8h_source.html">ZoneInfoHigh.h</a></code>.
<p>These classes provide a thin layer of indirection for accessing the data structures defined by <code><a class="el" href="ZoneInfoHigh_8h.html" title="Data structures that encodes the high resolution zoneinfo database persistence format.">ZoneInfoHigh.h</a></code>.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;Arduino.h&gt;</code><br />
<code>#include &lt;AceCommon.h&gt;</code><br />
<code>#include &quot;<a class="el" href="compat_8h_source.html">compat.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="BrokerCommon_8h_source.html">BrokerCommon.h</a>&quot;</code><br />
<code>#include &quot;ZoneInfoHigh.h&quot;</code><br />
<code>#include &quot;<a class="el" href="ZoneInfoHigh_8h_source.html">ZoneInfoHigh.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for BrokersHigh.h:</div>
<div class="dyncontent">
Expand All @@ -94,7 +94,7 @@
<area shape="rect" title=" " alt="" coords="139,95,257,121"/>
<area shape="rect" href="compat_8h.html" title="Macros and definitions that provide a consistency layer among the various Arduino boards for compatib..." alt="" coords="587,95,670,121"/>
<area shape="rect" href="BrokerCommon_8h.html" title="Helper functions are used in both Basic brokers and Extended brokers." alt="" coords="281,95,416,121"/>
<area shape="rect" href="ZoneInfoHigh_8h_source.html" title=" " alt="" coords="441,95,563,121"/>
<area shape="rect" href="ZoneInfoHigh_8h.html" title="Data structures that encodes the high resolution zoneinfo database persistence format." alt="" coords="441,95,563,121"/>
<area shape="rect" title=" " alt="" coords="491,169,561,196"/>
<area shape="rect" title=" " alt="" coords="586,169,671,196"/>
<area shape="rect" title=" " alt="" coords="695,169,797,196"/>
Expand Down Expand Up @@ -175,7 +175,7 @@
<tr class="separator:a4f2137b865f26ef213c9712e1ed7a7f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>These classes provide a thin layer of indirection for accessing the data structures defined by <code><a class="el" href="ZoneInfoHigh_8h_source.html">ZoneInfoHigh.h</a></code>. </p>
<div class="textblock"><p>These classes provide a thin layer of indirection for accessing the data structures defined by <code><a class="el" href="ZoneInfoHigh_8h.html" title="Data structures that encodes the high resolution zoneinfo database persistence format.">ZoneInfoHigh.h</a></code>. </p>
<p>The zoneinfo files are stored in flash memory (using the PROGMEM keyword), and cannot be accessed directly on microcontrollers using the Harvard architecture (e.g. AVR) where data and program live in 2 different address spaces. The data in flash memory must be accessed using helper routines in &lt;pgmspace.h&gt;. These classes abstract away this difference so that the code BasicZoneProcessor and ExtendedZoneProcessor can be written to be (mostly) agnostic to how the zoneinfo files are stored. </p>

<p class="definition">Definition in file <a class="el" href="BrokersHigh_8h_source.html">BrokersHigh.h</a>.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/BrokersHigh_8h__incl.map
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<area shape="rect" id="node4" title=" " alt="" coords="139,95,257,121"/>
<area shape="rect" id="node5" href="$compat_8h.html" title="Macros and definitions that provide a consistency layer among the various Arduino boards for compatib..." alt="" coords="587,95,670,121"/>
<area shape="rect" id="node9" href="$BrokerCommon_8h.html" title="Helper functions are used in both Basic brokers and Extended brokers." alt="" coords="281,95,416,121"/>
<area shape="rect" id="node10" href="$ZoneInfoHigh_8h_source.html" title=" " alt="" coords="441,95,563,121"/>
<area shape="rect" id="node10" href="$ZoneInfoHigh_8h.html" title="Data structures that encodes the high resolution zoneinfo database persistence format." alt="" coords="441,95,563,121"/>
<area shape="rect" id="node6" title=" " alt="" coords="491,169,561,196"/>
<area shape="rect" id="node7" title=" " alt="" coords="586,169,671,196"/>
<area shape="rect" id="node8" title=" " alt="" coords="695,169,797,196"/>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/BrokersHigh_8h__incl.md5
Original file line number Diff line number Diff line change
@@ -1 +1 @@
c5bf13b48a3cfaa3a5627c91f36f0233
068d3a1e434e52a9f77b2e21f5fe1070
5 changes: 3 additions & 2 deletions docs/html/BrokersHigh_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">AceTime
&#160;<span id="projectnumber">2.3.0</span>
&#160;<span id="projectnumber">2.4.0</span>
</div>
<div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database.</div>
</td>
Expand Down Expand Up @@ -84,7 +84,7 @@
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;AceCommon.h&gt;</span> <span class="comment">// KString</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="compat_8h.html">compat.h</a>&quot;</span> <span class="comment">// ACE_TIME_USE_PROGMEM</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="BrokerCommon_8h.html">BrokerCommon.h</a>&quot;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &quot;ZoneInfoHigh.h&quot;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ZoneInfoHigh_8h.html">ZoneInfoHigh.h</a>&quot;</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">class </span>__FlashStringHelper;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">class </span>Print;</div>
Expand Down Expand Up @@ -467,6 +467,7 @@
<div class="ttc" id="aBrokersHigh_8h_html_a4f2137b865f26ef213c9712e1ed7a7f2"><div class="ttname"><a href="BrokersHigh_8h.html#a4f2137b865f26ef213c9712e1ed7a7f2">ace_time::zoneinfohigh::toSuffix</a></div><div class="ttdeci">uint8_t toSuffix(uint8_t modifier)</div><div class="ttdoc">Extract the 'w', 's' 'u' suffix from the 'modifier' field, so that they can be compared against kSuff...</div><div class="ttdef"><b>Definition:</b> <a href="BrokersHigh_8h_source.html#l00069">BrokersHigh.h:69</a></div></div>
<div class="ttc" id="aBrokersHigh_8h_html_ad32a487aeefa3d1592e64962d68ef040"><div class="ttname"><a href="BrokersHigh_8h.html#ad32a487aeefa3d1592e64962d68ef040">ace_time::zoneinfohigh::toDeltaSeconds</a></div><div class="ttdeci">int32_t toDeltaSeconds(uint8_t deltaMinutes)</div><div class="ttdoc">Convert the deltaMinutes holding the RULES/DSTOFF field in ZoneEra or the SAVE field in ZoneRule to d...</div><div class="ttdef"><b>Definition:</b> <a href="BrokersHigh_8h_source.html#l00043">BrokersHigh.h:43</a></div></div>
<div class="ttc" id="aBrokersHigh_8h_html_afc690897ee551c81120c7d530f3ba884"><div class="ttname"><a href="BrokersHigh_8h.html#afc690897ee551c81120c7d530f3ba884">ace_time::zoneinfohigh::toOffsetSeconds</a></div><div class="ttdeci">int32_t toOffsetSeconds(uint16_t offsetCode, uint8_t offsetRemainder)</div><div class="ttdoc">Convert (code, remainder) holding the STDOFF field of ZoneEra into seconds.</div><div class="ttdef"><b>Definition:</b> <a href="BrokersHigh_8h_source.html#l00050">BrokersHigh.h:50</a></div></div>
<div class="ttc" id="aZoneInfoHigh_8h_html"><div class="ttname"><a href="ZoneInfoHigh_8h.html">ZoneInfoHigh.h</a></div><div class="ttdoc">Data structures that encodes the high resolution zoneinfo database persistence format.</div></div>
<div class="ttc" id="aclassace__time_1_1zoneinfohigh_1_1ZoneContextBroker_html"><div class="ttname"><a href="classace__time_1_1zoneinfohigh_1_1ZoneContextBroker.html">ace_time::zoneinfohigh::ZoneContextBroker</a></div><div class="ttdoc">Data broker for accessing a ZoneContext.</div><div class="ttdef"><b>Definition:</b> <a href="BrokersHigh_8h_source.html#l00081">BrokersHigh.h:81</a></div></div>
<div class="ttc" id="aclassace__time_1_1zoneinfohigh_1_1ZoneEraBroker_html"><div class="ttname"><a href="classace__time_1_1zoneinfohigh_1_1ZoneEraBroker.html">ace_time::zoneinfohigh::ZoneEraBroker</a></div><div class="ttdoc">Data broker for accessing ZoneEra.</div><div class="ttdef"><b>Definition:</b> <a href="BrokersHigh_8h_source.html#l00270">BrokersHigh.h:270</a></div></div>
<div class="ttc" id="aclassace__time_1_1zoneinfohigh_1_1ZoneInfoBroker_html"><div class="ttname"><a href="classace__time_1_1zoneinfohigh_1_1ZoneInfoBroker.html">ace_time::zoneinfohigh::ZoneInfoBroker</a></div><div class="ttdoc">Data broker for accessing ZoneInfo.</div><div class="ttdef"><b>Definition:</b> <a href="BrokersHigh_8h_source.html#l00348">BrokersHigh.h:348</a></div></div>
Expand Down
10 changes: 5 additions & 5 deletions docs/html/BrokersLow_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">AceTime
&#160;<span id="projectnumber">2.3.0</span>
&#160;<span id="projectnumber">2.4.0</span>
</div>
<div id="projectbrief">Date and time classes for Arduino that support timezones from the TZ Database.</div>
</td>
Expand Down Expand Up @@ -75,14 +75,14 @@
</div><!--header-->
<div class="contents">

<p>These classes provide a thin layer of indirection for accessing the data structures defined by <code><a class="el" href="ZoneInfoLow_8h_source.html">ZoneInfoLow.h</a></code>.
<p>These classes provide a thin layer of indirection for accessing the data structures defined by <code><a class="el" href="ZoneInfoLow_8h.html" title="Data structures describe the low resolution zoneinfo persistence format.">ZoneInfoLow.h</a></code>.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;Arduino.h&gt;</code><br />
<code>#include &lt;AceCommon.h&gt;</code><br />
<code>#include &quot;<a class="el" href="compat_8h_source.html">compat.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="BrokerCommon_8h_source.html">BrokerCommon.h</a>&quot;</code><br />
<code>#include &quot;ZoneInfoLow.h&quot;</code><br />
<code>#include &quot;<a class="el" href="ZoneInfoLow_8h_source.html">ZoneInfoLow.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for BrokersLow.h:</div>
<div class="dyncontent">
Expand All @@ -94,7 +94,7 @@
<area shape="rect" title=" " alt="" coords="139,95,257,121"/>
<area shape="rect" href="compat_8h.html" title="Macros and definitions that provide a consistency layer among the various Arduino boards for compatib..." alt="" coords="582,95,665,121"/>
<area shape="rect" href="BrokerCommon_8h.html" title="Helper functions are used in both Basic brokers and Extended brokers." alt="" coords="281,95,416,121"/>
<area shape="rect" href="ZoneInfoLow_8h_source.html" title=" " alt="" coords="441,95,558,121"/>
<area shape="rect" href="ZoneInfoLow_8h.html" title="Data structures describe the low resolution zoneinfo persistence format." alt="" coords="441,95,558,121"/>
<area shape="rect" title=" " alt="" coords="485,169,556,196"/>
<area shape="rect" title=" " alt="" coords="581,169,666,196"/>
<area shape="rect" title=" " alt="" coords="690,169,791,196"/>
Expand Down Expand Up @@ -173,7 +173,7 @@
<tr class="separator:a448746bf635780d48bf749ad26a06fbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>These classes provide a thin layer of indirection for accessing the data structures defined by <code><a class="el" href="ZoneInfoLow_8h_source.html">ZoneInfoLow.h</a></code>. </p>
<div class="textblock"><p>These classes provide a thin layer of indirection for accessing the data structures defined by <code><a class="el" href="ZoneInfoLow_8h.html" title="Data structures describe the low resolution zoneinfo persistence format.">ZoneInfoLow.h</a></code>. </p>
<p>The zoneinfo files are stored in flash memory (using the PROGMEM keyword), and cannot be accessed directly on microcontrollers using the Harvard architecture (e.g. AVR) where data and program live in 2 different address spaces. The data in flash memory must be accessed using helper routines in &lt;pgmspace.h&gt;. These classes abstract away this difference so that the code BasicZoneProcessor and ExtendedZoneProcessor can be written to be (mostly) agnostic to how the zoneinfo files are stored. </p>

<p class="definition">Definition in file <a class="el" href="BrokersLow_8h_source.html">BrokersLow.h</a>.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/BrokersLow_8h__incl.map
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<area shape="rect" id="node4" title=" " alt="" coords="139,95,257,121"/>
<area shape="rect" id="node5" href="$compat_8h.html" title="Macros and definitions that provide a consistency layer among the various Arduino boards for compatib..." alt="" coords="582,95,665,121"/>
<area shape="rect" id="node9" href="$BrokerCommon_8h.html" title="Helper functions are used in both Basic brokers and Extended brokers." alt="" coords="281,95,416,121"/>
<area shape="rect" id="node10" href="$ZoneInfoLow_8h_source.html" title=" " alt="" coords="441,95,558,121"/>
<area shape="rect" id="node10" href="$ZoneInfoLow_8h.html" title="Data structures describe the low resolution zoneinfo persistence format." alt="" coords="441,95,558,121"/>
<area shape="rect" id="node6" title=" " alt="" coords="485,169,556,196"/>
<area shape="rect" id="node7" title=" " alt="" coords="581,169,666,196"/>
<area shape="rect" id="node8" title=" " alt="" coords="690,169,791,196"/>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/BrokersLow_8h__incl.md5
Original file line number Diff line number Diff line change
@@ -1 +1 @@
73e418df9292c0e8dde722a4df3002c6
203a8de19c4f81b9cdd3be45d68d1ed9
Loading

0 comments on commit f16adde

Please sign in to comment.