Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@fdivitto
fdivitto committed May 23, 2021
1 parent 8f79466 commit 1095bf1
Show file tree
Hide file tree
Showing 2,115 changed files with 43,954 additions and 9,332 deletions.
11 changes: 6 additions & 5 deletions docs/html/_d_s3231_8cpp_source.html
View file

Large diffs are not rendered by default.

44 changes: 42 additions & 2 deletions docs/html/_d_s3231_8h.html
View file
Expand Up @@ -21,6 +21,7 @@
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
Expand Down Expand Up @@ -95,7 +96,46 @@

<p>This file contains the DS3231 (Real Time Clock) device driver.
<a href="#details">More...</a></p>

<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;stddef.h&gt;</code><br />
<code>#include &quot;freertos/FreeRTOS.h&quot;</code><br />
<code>#include &quot;<a class="el" href="fabglconf_8h_source.html">fabglconf.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="fabutils_8h_source.html">fabutils.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="tsi2c_8h_source.html">comdrivers/tsi2c.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for DS3231.h:</div>
<div class="dyncontent">
<div class="center"><img src="_d_s3231_8h__incl.png" border="0" usemap="#_d_s3231_8h" alt=""/></div>
<map name="_d_s3231_8h" id="_d_s3231_8h">
<area shape="rect" id="node5" href="fabglconf_8h.html" title="This file contains FabGL library configuration settings, like number of supported colors..." alt="" coords="189,155,276,181"/>
<area shape="rect" id="node7" href="fabutils_8h.html" title="This file contains some utility classes and functions. " alt="" coords="735,80,810,107"/>
<area shape="rect" id="node11" href="tsi2c_8h.html" title="This file contains fabgl::I2C definition. " alt="" coords="283,80,412,107"/>
</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="#_d_s3231_8hdep" alt=""/></div>
<map name="_d_s3231_8hdep" id="_d_s3231_8hdep">
<area shape="rect" id="node2" 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="399,80,460,107"/>
<area shape="rect" id="node17" href="_d_s3231_8cpp_source.html" title="DS3231.cpp" alt="" coords="485,80,579,107"/>
<area shape="rect" id="node3" href="graphicsadapter_8h.html" title="This file contains fabgl::GraphicsAdapter definition. " alt="" coords="27,155,151,181"/>
<area shape="rect" id="node5" href="i8042_8h_source.html" title="i8042.h" alt="" coords="183,155,247,181"/>
<area shape="rect" id="node7" href="i8086_8h_source.html" title="i8086.h" alt="" coords="285,155,349,181"/>
<area shape="rect" id="node9" href="_m_c146818_8h_source.html" title="MC146818.h" alt="" coords="381,155,477,181"/>
<area shape="rect" id="node11" href="_p_i_c8259_8h_source.html" title="PIC8259.h" alt="" coords="509,155,593,181"/>
<area shape="rect" id="node13" href="_p_i_t8253_8h_source.html" title="PIT8253.h" alt="" coords="628,155,711,181"/>
<area shape="rect" id="node15" href="_v_i_a6522_8h.html" title="This file contains fabgl::VIA6522 definition. " alt="" coords="747,155,829,181"/>
<area shape="rect" id="node4" href="graphicsadapter_8cpp_source.html" title="graphicsadapter.cpp" alt="" coords="5,229,144,256"/>
<area shape="rect" id="node6" href="i8042_8cpp_source.html" title="i8042.cpp" alt="" coords="169,229,247,256"/>
<area shape="rect" id="node8" href="i8086_8cpp_source.html" title="i8086.cpp" alt="" coords="271,229,350,256"/>
<area shape="rect" id="node10" href="_m_c146818_8cpp_source.html" title="MC146818.cpp" alt="" coords="374,229,485,256"/>
<area shape="rect" id="node12" href="_p_i_c8259_8cpp_source.html" title="PIC8259.cpp" alt="" coords="509,229,608,256"/>
<area shape="rect" id="node14" href="_p_i_t8253_8cpp_source.html" title="PIT8253.cpp" alt="" coords="632,229,728,256"/>
<area shape="rect" id="node16" href="_v_i_a6522_8cpp_source.html" title="VIA6522.cpp" alt="" coords="753,229,850,256"/>
</map>
</div>
</div>
<p><a href="_d_s3231_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Expand All @@ -117,7 +157,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 Wed Dec 9 2020 16:48:31 for FabGL by
<li class="footer">Generated on Sun May 23 2021 23:04:33 for FabGL by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
Expand Down
17 changes: 16 additions & 1 deletion docs/html/_d_s3231_8h__dep__incl.map
View file
@@ -1,3 +1,18 @@
<map id="DS3231.h" name="DS3231.h">
<area shape="rect" id="node2" 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="15,79,76,104"/>
<area shape="rect" id="node2" 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="399,80,460,107"/>
<area shape="rect" id="node17" href="$_d_s3231_8cpp_source.html" title="DS3231.cpp" alt="" coords="485,80,579,107"/>
<area shape="rect" id="node3" href="$graphicsadapter_8h.html" title="This file contains fabgl::GraphicsAdapter definition. " alt="" coords="27,155,151,181"/>
<area shape="rect" id="node5" href="$i8042_8h_source.html" title="i8042.h" alt="" coords="183,155,247,181"/>
<area shape="rect" id="node7" href="$i8086_8h_source.html" title="i8086.h" alt="" coords="285,155,349,181"/>
<area shape="rect" id="node9" href="$_m_c146818_8h_source.html" title="MC146818.h" alt="" coords="381,155,477,181"/>
<area shape="rect" id="node11" href="$_p_i_c8259_8h_source.html" title="PIC8259.h" alt="" coords="509,155,593,181"/>
<area shape="rect" id="node13" href="$_p_i_t8253_8h_source.html" title="PIT8253.h" alt="" coords="628,155,711,181"/>
<area shape="rect" id="node15" href="$_v_i_a6522_8h.html" title="This file contains fabgl::VIA6522 definition. " alt="" coords="747,155,829,181"/>
<area shape="rect" id="node4" href="$graphicsadapter_8cpp_source.html" title="graphicsadapter.cpp" alt="" coords="5,229,144,256"/>
<area shape="rect" id="node6" href="$i8042_8cpp_source.html" title="i8042.cpp" alt="" coords="169,229,247,256"/>
<area shape="rect" id="node8" href="$i8086_8cpp_source.html" title="i8086.cpp" alt="" coords="271,229,350,256"/>
<area shape="rect" id="node10" href="$_m_c146818_8cpp_source.html" title="MC146818.cpp" alt="" coords="374,229,485,256"/>
<area shape="rect" id="node12" href="$_p_i_c8259_8cpp_source.html" title="PIC8259.cpp" alt="" coords="509,229,608,256"/>
<area shape="rect" id="node14" href="$_p_i_t8253_8cpp_source.html" title="PIT8253.cpp" alt="" coords="632,229,728,256"/>
<area shape="rect" id="node16" href="$_v_i_a6522_8cpp_source.html" title="VIA6522.cpp" alt="" coords="753,229,850,256"/>
</map>
2 changes: 1 addition & 1 deletion docs/html/_d_s3231_8h__dep__incl.md5
View file
@@ -1 +1 @@
8e37ffde86eca34db911c974efaa23fd
18dc9642dcd4464c7e992cbdb47a6c0f
Binary file modified docs/html/_d_s3231_8h__dep__incl.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/html/_d_s3231_8h__incl.map
View file
@@ -1,5 +1,5 @@
<map id="DS3231.h" name="DS3231.h">
<area shape="rect" id="node5" href="$fabglconf_8h.html" title="This file contains FabGL library configuration settings, like number of supported colors..." alt="" coords="878,152,965,177"/>
<area shape="rect" id="node7" href="$fabutils_8h.html" title="This file contains some utility classes and functions. " alt="" coords="156,79,231,104"/>
<area shape="rect" id="node9" href="$tsi2c_8h.html" title="This file contains fabgl::I2C definition. " alt="" coords="457,79,586,104"/>
<area shape="rect" id="node5" href="$fabglconf_8h.html" title="This file contains FabGL library configuration settings, like number of supported colors..." alt="" coords="189,155,276,181"/>
<area shape="rect" id="node7" href="$fabutils_8h.html" title="This file contains some utility classes and functions. " alt="" coords="735,80,810,107"/>
<area shape="rect" id="node11" href="$tsi2c_8h.html" title="This file contains fabgl::I2C definition. " alt="" coords="283,80,412,107"/>
</map>
2 changes: 1 addition & 1 deletion docs/html/_d_s3231_8h__incl.md5
View file
@@ -1 +1 @@
185681f845d4f359608749df56f1dd14
98575ce893ac208030d992b95bf62e73
Binary file modified docs/html/_d_s3231_8h__incl.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 4 additions & 3 deletions docs/html/_d_s3231_8h_source.html
View file

Large diffs are not rendered by default.

7 changes: 4 additions & 3 deletions docs/html/_i_c_m_p_8cpp_source.html
View file

Large diffs are not rendered by default.

30 changes: 28 additions & 2 deletions docs/html/_i_c_m_p_8h.html
View file
Expand Up @@ -21,6 +21,7 @@
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
Expand Down Expand Up @@ -95,7 +96,32 @@

<p>This file contains ICMP (ping) class.
<a href="#details">More...</a></p>

<div class="textblock"><code>#include &quot;Client.h&quot;</code><br />
<code>#include &quot;freertos/FreeRTOS.h&quot;</code><br />
<code>#include &quot;lwip/netdb.h&quot;</code><br />
<code>#include &quot;lwip/raw.h&quot;</code><br />
<code>#include &quot;lwip/icmp.h&quot;</code><br />
<code>#include &quot;lwip/inet_chksum.h&quot;</code><br />
<code>#include &quot;<a class="el" href="fabglconf_8h_source.html">fabglconf.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="fabutils_8h_source.html">fabutils.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for ICMP.h:</div>
<div class="dyncontent">
<div class="center"><img src="_i_c_m_p_8h__incl.png" border="0" usemap="#_i_c_m_p_8h" alt=""/></div>
<map name="_i_c_m_p_8h" id="_i_c_m_p_8h">
<area shape="rect" id="node8" href="fabglconf_8h.html" title="This file contains FabGL library configuration settings, like number of supported colors..." alt="" coords="97,80,183,107"/>
<area shape="rect" id="node10" href="fabutils_8h.html" title="This file contains some utility classes and functions. " alt="" coords="785,80,860,107"/>
</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="_i_c_m_p_8h__dep__incl.png" border="0" usemap="#_i_c_m_p_8hdep" alt=""/></div>
<map name="_i_c_m_p_8hdep" id="_i_c_m_p_8hdep">
<area shape="rect" id="node2" href="_i_c_m_p_8cpp_source.html" title="ICMP.cpp" alt="" coords="5,80,84,107"/>
</map>
</div>
</div>
<p><a href="_i_c_m_p_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Expand All @@ -114,7 +140,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_fc4c7f03e1a69a98c370fae55a743828.html">network</a></li><li class="navelem"><a class="el" href="_i_c_m_p_8h.html">ICMP.h</a></li>
<li class="footer">Generated on Wed Dec 9 2020 16:48:31 for FabGL by
<li class="footer">Generated on Sun May 23 2021 23:04:33 for FabGL by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
Expand Down
3 changes: 3 additions & 0 deletions docs/html/_i_c_m_p_8h__dep__incl.map
View file
@@ -0,0 +1,3 @@
<map id="ICMP.h" name="ICMP.h">
<area shape="rect" id="node2" href="$_i_c_m_p_8cpp_source.html" title="ICMP.cpp" alt="" coords="5,80,84,107"/>
</map>
1 change: 1 addition & 0 deletions docs/html/_i_c_m_p_8h__dep__incl.md5
View file
@@ -0,0 +1 @@
86382696f789e664214961d254d9a67d
Binary file added docs/html/_i_c_m_p_8h__dep__incl.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/html/_i_c_m_p_8h__incl.map
View file
@@ -0,0 +1,4 @@
<map id="ICMP.h" name="ICMP.h">
<area shape="rect" id="node8" href="$fabglconf_8h.html" title="This file contains FabGL library configuration settings, like number of supported colors..." alt="" coords="97,80,183,107"/>
<area shape="rect" id="node10" href="$fabutils_8h.html" title="This file contains some utility classes and functions. " alt="" coords="785,80,860,107"/>
</map>
1 change: 1 addition & 0 deletions docs/html/_i_c_m_p_8h__incl.md5
View file
@@ -0,0 +1 @@
34a0fef94464cc7ece0ec6f3f95e0385
Binary file added docs/html/_i_c_m_p_8h__incl.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1095bf1

Please sign in to comment.