Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@fdivitto
fdivitto committed Aug 29, 2022
1 parent a9e49b1 commit 4edd0d5
Show file tree
Hide file tree
Showing 2,083 changed files with 42,990 additions and 33,433 deletions.
4 changes: 2 additions & 2 deletions docs/html/_d_s3231_8cpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@
<div class="ttc" id="aclassfabgl_1_1_d_s3231_afde0362b6ad07f120d3a03ed191a54cb_html_afde0362b6ad07f120d3a03ed191a54cb"><div class="ttname"><a href="classfabgl_1_1_d_s3231_afde0362b6ad07f120d3a03ed191a54cb.html#afde0362b6ad07f120d3a03ed191a54cb">fabgl::DS3231::clockEnabled</a></div><div class="ttdeci">void clockEnabled(bool value)</div><div class="ttdoc">Enables or disables DS3231 oscillator.</div><div class="ttdef"><b>Definition:</b> <a href="_d_s3231_8cpp_source.html#l00203">DS3231.cpp:203</a></div></div>
<div class="ttc" id="aclassfabgl_1_1_i2_c_a5683609bed861f2c075c25d935029e3f_html_a5683609bed861f2c075c25d935029e3f"><div class="ttname"><a href="classfabgl_1_1_i2_c_a5683609bed861f2c075c25d935029e3f.html#a5683609bed861f2c075c25d935029e3f">fabgl::I2C::write</a></div><div class="ttdeci">bool write(int address, uint8_t *buffer, int size, int frequency=100000, int timeOutMS=50)</div><div class="ttdoc">Sends a buffer to I2C bus.</div><div class="ttdef"><b>Definition:</b> <a href="tsi2c_8cpp_source.html#l00113">tsi2c.cpp:113</a></div></div>
<div class="ttc" id="aclassfabgl_1_1_i2_c_aee6d332047f3429253a95c94c59cccd9_html_aee6d332047f3429253a95c94c59cccd9"><div class="ttname"><a href="classfabgl_1_1_i2_c_aee6d332047f3429253a95c94c59cccd9.html#aee6d332047f3429253a95c94c59cccd9">fabgl::I2C::read</a></div><div class="ttdeci">int read(int address, uint8_t *buffer, int size, int frequency=100000, int timeOutMS=50)</div><div class="ttdoc">Receives a buffer from I2C bus.</div><div class="ttdef"><b>Definition:</b> <a href="tsi2c_8cpp_source.html#l00141">tsi2c.cpp:141</a></div></div>
<div class="ttc" id="aclassfabgl_1_1_i2_c_html"><div class="ttname"><a href="classfabgl_1_1_i2_c.html">fabgl::I2C</a></div><div class="ttdoc">I2C class allows multiple tasks to communicate with I2C devices, serializing read/write jobs.</div><div class="ttdef"><b>Definition:</b> <a href="tsi2c_8h_source.html#l00085">tsi2c.h:85</a></div></div>
<div class="ttc" id="aclassfabgl_1_1_i2_c_html"><div class="ttname"><a href="classfabgl_1_1_i2_c.html">fabgl::I2C</a></div><div class="ttdoc">I2C class allows multiple tasks to communicate with I2C devices, serializing read/write jobs.</div><div class="ttdef"><b>Definition:</b> <a href="tsi2c_8h_source.html#l00094">tsi2c.h:94</a></div></div>
<div class="ttc" id="astructfabgl_1_1_date_time_a45bbbde67ef492a5d10a9d519f86984c_html_a45bbbde67ef492a5d10a9d519f86984c"><div class="ttname"><a href="structfabgl_1_1_date_time_a45bbbde67ef492a5d10a9d519f86984c.html#a45bbbde67ef492a5d10a9d519f86984c">fabgl::DateTime::seconds</a></div><div class="ttdeci">int8_t seconds</div><div class="ttdef"><b>Definition:</b> <a href="_d_s3231_8h_source.html#l00059">DS3231.h:59</a></div></div>
<div class="ttc" id="astructfabgl_1_1_date_time_a5f0b5de23fa9acb3542c09b4d8e338e6_html_a5f0b5de23fa9acb3542c09b4d8e338e6"><div class="ttname"><a href="structfabgl_1_1_date_time_a5f0b5de23fa9acb3542c09b4d8e338e6.html#a5f0b5de23fa9acb3542c09b4d8e338e6">fabgl::DateTime::dayOfMonth</a></div><div class="ttdeci">int8_t dayOfMonth</div><div class="ttdef"><b>Definition:</b> <a href="_d_s3231_8h_source.html#l00063">DS3231.h:63</a></div></div>
<div class="ttc" id="astructfabgl_1_1_date_time_a82e68d1d8e1634ac2ba0d01fe0cd95c9_html_a82e68d1d8e1634ac2ba0d01fe0cd95c9"><div class="ttname"><a href="structfabgl_1_1_date_time_a82e68d1d8e1634ac2ba0d01fe0cd95c9.html#a82e68d1d8e1634ac2ba0d01fe0cd95c9">fabgl::DateTime::month</a></div><div class="ttdeci">int8_t month</div><div class="ttdef"><b>Definition:</b> <a href="_d_s3231_8h_source.html#l00064">DS3231.h:64</a></div></div>
Expand All @@ -318,7 +318,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_82e8a5453e51b0b6168db3257bd0eaab.html">devdrivers</a></li><li class="navelem"><b>DS3231.cpp</b></li>
<li class="footer">Generated on Sun May 22 2022 11:19:45 for FabGL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </li>
<li class="footer">Generated on Mon Aug 29 2022 13:52:04 for FabGL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </li>
</ul>
</div>
</body>
Expand Down
67 changes: 36 additions & 31 deletions docs/html/_d_s3231_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,45 +103,50 @@
<div class="dyncontent">
<div class="center"><img src="_d_s3231_8h__incl.png" border="0" usemap="#a_d_s3231_8h" alt=""/></div>
<map name="a_d_s3231_8h" id="a_d_s3231_8h">
<area shape="rect" title="This file contains the DS3231 (Real Time Clock) device driver." alt="" coords="293,5,373,32"/>
<area shape="rect" title=" " alt="" coords="26,155,91,181"/>
<area shape="rect" title=" " alt="" coords="116,155,185,181"/>
<area shape="rect" title=" " alt="" coords="160,229,304,256"/>
<area shape="rect" href="fabglconf_8h.html" title="This file contains FabGL library configuration settings, like number of supported colors,..." alt="" coords="665,155,751,181"/>
<area shape="rect" href="fabutils_8h.html" title="This file contains some utility classes and functions." alt="" coords="565,155,640,181"/>
<area shape="rect" href="tsi2c_8h.html" title="This file contains fabgl::I2C definition." alt="" coords="330,80,459,107"/>
<area shape="rect" title=" " alt="" coords="1010,229,1091,256"/>
<area shape="rect" title=" " alt="" coords="328,229,451,256"/>
<area shape="rect" title=" " alt="" coords="767,229,857,256"/>
<area shape="rect" title=" " alt="" coords="881,229,985,256"/>
<area shape="rect" title=" " alt="" coords="475,229,583,256"/>
<area shape="rect" title=" " alt="" coords="607,229,742,256"/>
<area shape="rect" title=" " alt="" coords="210,155,326,181"/>
<area shape="rect" title=" " alt="" coords="350,155,439,181"/>
<area shape="rect" title="This file contains the DS3231 (Real Time Clock) device driver." alt="" coords="194,5,274,32"/>
<area shape="rect" title=" " alt="" coords="168,155,233,181"/>
<area shape="rect" title=" " alt="" coords="258,155,327,181"/>
<area shape="rect" title=" " alt="" coords="245,229,389,256"/>
<area shape="rect" href="fabglconf_8h.html" title="This file contains FabGL library configuration settings, like number of supported colors,..." alt="" coords="5,155,92,181"/>
<area shape="rect" href="fabutils_8h.html" title="This file contains some utility classes and functions." alt="" coords="838,155,913,181"/>
<area shape="rect" href="tsi2c_8h.html" title="This file contains fabgl::I2C definition." alt="" coords="317,80,447,107"/>
<area shape="rect" title=" " alt="" coords="8,229,89,256"/>
<area shape="rect" title=" " alt="" coords="413,229,535,256"/>
<area shape="rect" title=" " alt="" coords="938,229,1029,256"/>
<area shape="rect" title=" " alt="" coords="1053,229,1157,256"/>
<area shape="rect" title=" " alt="" coords="1181,229,1289,256"/>
<area shape="rect" title=" " alt="" coords="560,229,695,256"/>
<area shape="rect" title=" " alt="" coords="719,229,813,256"/>
<area shape="rect" title=" " alt="" coords="837,229,914,256"/>
<area shape="rect" title=" " alt="" coords="453,155,569,181"/>
<area shape="rect" title=" " alt="" coords="593,155,683,181"/>
<area shape="rect" title=" " alt="" coords="707,155,814,181"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="_d_s3231_8h__dep__incl.png" border="0" usemap="#a_d_s3231_8hdep" alt=""/></div>
<map name="a_d_s3231_8hdep" id="a_d_s3231_8hdep">
<area shape="rect" title="This file contains the DS3231 (Real Time Clock) device driver." alt="" coords="341,5,421,32"/>
<area shape="rect" href="_d_s3231_8cpp_source.html" title=" " alt="" coords="283,80,377,107"/>
<area shape="rect" href="fabgl_8h.html" title="This file is the all in one include file. Application can just include this file to use FabGL library..." alt="" coords="402,80,463,107"/>
<area shape="rect" title="This file contains the DS3231 (Real Time Clock) device driver." alt="" coords="398,5,478,32"/>
<area shape="rect" href="_d_s3231_8cpp_source.html" title=" " alt="" coords="340,80,435,107"/>
<area shape="rect" href="fabgl_8h.html" title="This file is the all in one include file. Application can just include this file to use FabGL library..." alt="" coords="459,80,521,107"/>
<area shape="rect" href="_m_c146818_8h_source.html" title=" " alt="" coords="27,155,123,181"/>
<area shape="rect" href="_p_i_c8259_8h_source.html" title=" " alt="" coords="155,155,239,181"/>
<area shape="rect" href="_p_i_t8253_8h_source.html" title=" " alt="" coords="277,155,359,181"/>
<area shape="rect" href="_v_i_a6522_8h.html" title="This file contains fabgl::VIA6522 definition." alt="" coords="391,155,474,181"/>
<area shape="rect" href="graphicsadapter_8h.html" title="This file contains fabgl::GraphicsAdapter definition." alt="" coords="505,155,629,181"/>
<area shape="rect" href="i8042_8h_source.html" title=" " alt="" coords="665,155,729,181"/>
<area shape="rect" href="i8086_8h_source.html" title=" " alt="" coords="766,155,830,181"/>
<area shape="rect" href="_p_c8250_8h.html" title="This file contains fabgl::PC8250 definition." alt="" coords="154,155,234,181"/>
<area shape="rect" href="_p_i_c8259_8h_source.html" title=" " alt="" coords="273,155,357,181"/>
<area shape="rect" href="_p_i_t8253_8h_source.html" title=" " alt="" coords="393,155,475,181"/>
<area shape="rect" href="_v_i_a6522_8h.html" title="This file contains fabgl::VIA6522 definition." alt="" coords="506,155,589,181"/>
<area shape="rect" href="graphicsadapter_8h.html" title="This file contains fabgl::GraphicsAdapter definition." alt="" coords="624,155,748,181"/>
<area shape="rect" href="i8042_8h_source.html" title=" " alt="" coords="786,155,850,181"/>
<area shape="rect" href="i8086_8h_source.html" title=" " alt="" coords="887,155,951,181"/>
<area shape="rect" href="_m_c146818_8cpp_source.html" title=" " alt="" coords="5,229,116,256"/>
<area shape="rect" href="_p_i_c8259_8cpp_source.html" title=" " alt="" coords="141,229,239,256"/>
<area shape="rect" href="_p_i_t8253_8cpp_source.html" title=" " alt="" coords="263,229,359,256"/>
<area shape="rect" href="_v_i_a6522_8cpp_source.html" title=" " alt="" coords="384,229,481,256"/>
<area shape="rect" href="graphicsadapter_8cpp_source.html" title=" " alt="" coords="506,229,645,256"/>
<area shape="rect" href="i8042_8cpp_source.html" title=" " alt="" coords="669,229,748,256"/>
<area shape="rect" href="i8086_8cpp_source.html" title=" " alt="" coords="772,229,851,256"/>
<area shape="rect" href="_p_c8250_8cpp_source.html" title=" " alt="" coords="140,229,235,256"/>
<area shape="rect" href="_p_i_c8259_8cpp_source.html" title=" " alt="" coords="259,229,358,256"/>
<area shape="rect" href="_p_i_t8253_8cpp_source.html" title=" " alt="" coords="382,229,478,256"/>
<area shape="rect" href="_v_i_a6522_8cpp_source.html" title=" " alt="" coords="503,229,600,256"/>
<area shape="rect" href="graphicsadapter_8cpp_source.html" title=" " alt="" coords="625,229,763,256"/>
<area shape="rect" href="i8042_8cpp_source.html" title=" " alt="" coords="788,229,867,256"/>
<area shape="rect" href="i8086_8cpp_source.html" title=" " alt="" coords="891,229,969,256"/>
</map>
</div>
</div>
Expand All @@ -166,7 +171,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_82e8a5453e51b0b6168db3257bd0eaab.html">devdrivers</a></li><li class="navelem"><a class="el" href="_d_s3231_8h.html">DS3231.h</a></li>
<li class="footer">Generated on Sun May 22 2022 11:19:45 for FabGL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </li>
<li class="footer">Generated on Mon Aug 29 2022 13:52:05 for FabGL by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </li>
</ul>
</div>
</body>
Expand Down
32 changes: 17 additions & 15 deletions docs/html/_d_s3231_8h__dep__incl.map
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
<map id="DS3231.h" name="DS3231.h">
<area shape="rect" id="node1" title="This file contains the DS3231 (Real Time Clock) device driver." alt="" coords="341,5,421,32"/>
<area shape="rect" id="node2" href="$_d_s3231_8cpp_source.html" title=" " alt="" coords="283,80,377,107"/>
<area shape="rect" id="node3" href="$fabgl_8h.html" title="This file is the all in one include file. Application can just include this file to use FabGL library..." alt="" coords="402,80,463,107"/>
<area shape="rect" id="node1" title="This file contains the DS3231 (Real Time Clock) device driver." alt="" coords="398,5,478,32"/>
<area shape="rect" id="node2" href="$_d_s3231_8cpp_source.html" title=" " alt="" coords="340,80,435,107"/>
<area shape="rect" id="node3" href="$fabgl_8h.html" title="This file is the all in one include file. Application can just include this file to use FabGL library..." alt="" coords="459,80,521,107"/>
<area shape="rect" id="node4" href="$_m_c146818_8h_source.html" title=" " alt="" coords="27,155,123,181"/>
<area shape="rect" id="node6" href="$_p_i_c8259_8h_source.html" title=" " alt="" coords="155,155,239,181"/>
<area shape="rect" id="node8" href="$_p_i_t8253_8h_source.html" title=" " alt="" coords="277,155,359,181"/>
<area shape="rect" id="node10" href="$_v_i_a6522_8h.html" title="This file contains fabgl::VIA6522 definition." alt="" coords="391,155,474,181"/>
<area shape="rect" id="node12" href="$graphicsadapter_8h.html" title="This file contains fabgl::GraphicsAdapter definition." alt="" coords="505,155,629,181"/>
<area shape="rect" id="node14" href="$i8042_8h_source.html" title=" " alt="" coords="665,155,729,181"/>
<area shape="rect" id="node16" href="$i8086_8h_source.html" title=" " alt="" coords="766,155,830,181"/>
<area shape="rect" id="node6" href="$_p_c8250_8h.html" title="This file contains fabgl::PC8250 definition." alt="" coords="154,155,234,181"/>
<area shape="rect" id="node8" href="$_p_i_c8259_8h_source.html" title=" " alt="" coords="273,155,357,181"/>
<area shape="rect" id="node10" href="$_p_i_t8253_8h_source.html" title=" " alt="" coords="393,155,475,181"/>
<area shape="rect" id="node12" href="$_v_i_a6522_8h.html" title="This file contains fabgl::VIA6522 definition." alt="" coords="506,155,589,181"/>
<area shape="rect" id="node14" href="$graphicsadapter_8h.html" title="This file contains fabgl::GraphicsAdapter definition." alt="" coords="624,155,748,181"/>
<area shape="rect" id="node16" href="$i8042_8h_source.html" title=" " alt="" coords="786,155,850,181"/>
<area shape="rect" id="node18" href="$i8086_8h_source.html" title=" " alt="" coords="887,155,951,181"/>
<area shape="rect" id="node5" href="$_m_c146818_8cpp_source.html" title=" " alt="" coords="5,229,116,256"/>
<area shape="rect" id="node7" href="$_p_i_c8259_8cpp_source.html" title=" " alt="" coords="141,229,239,256"/>
<area shape="rect" id="node9" href="$_p_i_t8253_8cpp_source.html" title=" " alt="" coords="263,229,359,256"/>
<area shape="rect" id="node11" href="$_v_i_a6522_8cpp_source.html" title=" " alt="" coords="384,229,481,256"/>
<area shape="rect" id="node13" href="$graphicsadapter_8cpp_source.html" title=" " alt="" coords="506,229,645,256"/>
<area shape="rect" id="node15" href="$i8042_8cpp_source.html" title=" " alt="" coords="669,229,748,256"/>
<area shape="rect" id="node17" href="$i8086_8cpp_source.html" title=" " alt="" coords="772,229,851,256"/>
<area shape="rect" id="node7" href="$_p_c8250_8cpp_source.html" title=" " alt="" coords="140,229,235,256"/>
<area shape="rect" id="node9" href="$_p_i_c8259_8cpp_source.html" title=" " alt="" coords="259,229,358,256"/>
<area shape="rect" id="node11" href="$_p_i_t8253_8cpp_source.html" title=" " alt="" coords="382,229,478,256"/>
<area shape="rect" id="node13" href="$_v_i_a6522_8cpp_source.html" title=" " alt="" coords="503,229,600,256"/>
<area shape="rect" id="node15" href="$graphicsadapter_8cpp_source.html" title=" " alt="" coords="625,229,763,256"/>
<area shape="rect" id="node17" href="$i8042_8cpp_source.html" title=" " alt="" coords="788,229,867,256"/>
<area shape="rect" id="node19" href="$i8086_8cpp_source.html" title=" " alt="" coords="891,229,969,256"/>
</map>
2 changes: 1 addition & 1 deletion docs/html/_d_s3231_8h__dep__incl.md5
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
e24ace6f551c02397088df8075a0bc58
e7dfe869bae58aec32bc634fbc667270
Binary file modified docs/html/_d_s3231_8h__dep__incl.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 18 additions & 15 deletions docs/html/_d_s3231_8h__incl.map
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
<map id="DS3231.h" name="DS3231.h">
<area shape="rect" id="node1" title="This file contains the DS3231 (Real Time Clock) device driver." alt="" coords="293,5,373,32"/>
<area shape="rect" id="node2" title=" " alt="" coords="26,155,91,181"/>
<area shape="rect" id="node3" title=" " alt="" coords="116,155,185,181"/>
<area shape="rect" id="node4" title=" " alt="" coords="160,229,304,256"/>
<area shape="rect" id="node5" href="$fabglconf_8h.html" title="This file contains FabGL library configuration settings, like number of supported colors,..." alt="" coords="665,155,751,181"/>
<area shape="rect" id="node7" href="$fabutils_8h.html" title="This file contains some utility classes and functions." alt="" coords="565,155,640,181"/>
<area shape="rect" id="node13" href="$tsi2c_8h.html" title="This file contains fabgl::I2C definition." alt="" coords="330,80,459,107"/>
<area shape="rect" id="node6" title=" " alt="" coords="1010,229,1091,256"/>
<area shape="rect" id="node8" title=" " alt="" coords="328,229,451,256"/>
<area shape="rect" id="node9" title=" " alt="" coords="767,229,857,256"/>
<area shape="rect" id="node10" title=" " alt="" coords="881,229,985,256"/>
<area shape="rect" id="node11" title=" " alt="" coords="475,229,583,256"/>
<area shape="rect" id="node12" title=" " alt="" coords="607,229,742,256"/>
<area shape="rect" id="node14" title=" " alt="" coords="210,155,326,181"/>
<area shape="rect" id="node15" title=" " alt="" coords="350,155,439,181"/>
<area shape="rect" id="node1" title="This file contains the DS3231 (Real Time Clock) device driver." alt="" coords="194,5,274,32"/>
<area shape="rect" id="node2" title=" " alt="" coords="168,155,233,181"/>
<area shape="rect" id="node3" title=" " alt="" coords="258,155,327,181"/>
<area shape="rect" id="node4" title=" " alt="" coords="245,229,389,256"/>
<area shape="rect" id="node5" href="$fabglconf_8h.html" title="This file contains FabGL library configuration settings, like number of supported colors,..." alt="" coords="5,155,92,181"/>
<area shape="rect" id="node7" href="$fabutils_8h.html" title="This file contains some utility classes and functions." alt="" coords="838,155,913,181"/>
<area shape="rect" id="node15" href="$tsi2c_8h.html" title="This file contains fabgl::I2C definition." alt="" coords="317,80,447,107"/>
<area shape="rect" id="node6" title=" " alt="" coords="8,229,89,256"/>
<area shape="rect" id="node8" title=" " alt="" coords="413,229,535,256"/>
<area shape="rect" id="node9" title=" " alt="" coords="938,229,1029,256"/>
<area shape="rect" id="node10" title=" " alt="" coords="1053,229,1157,256"/>
<area shape="rect" id="node11" title=" " alt="" coords="1181,229,1289,256"/>
<area shape="rect" id="node12" title=" " alt="" coords="560,229,695,256"/>
<area shape="rect" id="node13" title=" " alt="" coords="719,229,813,256"/>
<area shape="rect" id="node14" title=" " alt="" coords="837,229,914,256"/>
<area shape="rect" id="node16" title=" " alt="" coords="453,155,569,181"/>
<area shape="rect" id="node17" title=" " alt="" coords="593,155,683,181"/>
<area shape="rect" id="node18" title=" " alt="" coords="707,155,814,181"/>
</map>
2 changes: 1 addition & 1 deletion docs/html/_d_s3231_8h__incl.md5
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
bec02c52c23b35f9803f273fb30acbcf
e84be63b0ffbd989f1aa542838c5a6f5
Binary file modified docs/html/_d_s3231_8h__incl.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 4edd0d5

Please sign in to comment.