Skip to content

Commit 96199c4

Browse files
author
Mario
committed
update documentation
1 parent 4295aba commit 96199c4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+525
-620
lines changed

‎extras/docs/api.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Makes it easy to read, write and keep logs of relevant data, such as sensor read
2929
`public size_t `[`readRows`](#class_s_p_i_f_f_s_logger_1aeceb2db3a41feb387e874f247657e19c)`(`[`SPIFFSLogData`](#struct_s_p_i_f_f_s_log_data)`< T > * output,time_t date,size_t startIdx,size_t maxCount)` | Read data from a daily logfile into a buffer.
3030
`public size_t `[`readRowsBetween`](#class_s_p_i_f_f_s_logger_1a8d82d01f694528becba720e0612dc48d)`(`[`SPIFFSLogData`](#struct_s_p_i_f_f_s_log_data)`< T > * output,time_t fromTime,time_t toTime,size_t startIdx,size_t maxCount)` |
3131
`public size_t `[`rowCount`](#class_s_p_i_f_f_s_logger_1ac539407d1bfebe9443393ea2e4047e29)`(time_t date)` | Get the number of entries for the specified date.
32+
`public size_t `[`rowCount`](#class_s_p_i_f_f_s_logger_1a7b59fa85e65ec2ca2fa2b26f22d4e936)`(File & logFile)` | Get the number of entries in the specified file.
3233
`public void `[`init`](#class_s_p_i_f_f_s_logger_base_1ad2270960852a999b0340fa4eab50f063)`()` | Initialize the logger.
3334
`public void `[`process`](#class_s_p_i_f_f_s_logger_base_1a22fdd2b540717853ae403edbc0ed1b7f)`()` | Process the file rotation and other required operations according to the defined processInterval.
3435
`protected time_t `[`_today`](#class_s_p_i_f_f_s_logger_base_1a77a967ae68a680dea5a647200ba49815) | current date, set in the last processing run
@@ -90,6 +91,16 @@ Get the number of entries for the specified date.
9091
#### Returns
9192
number of entries
9293

94+
#### `public size_t `[`rowCount`](#class_s_p_i_f_f_s_logger_1a7b59fa85e65ec2ca2fa2b26f22d4e936)`(File & logFile)`
95+
96+
Get the number of entries in the specified file.
97+
98+
#### Parameters
99+
* `logFile` a File object for a valid logfile
100+
101+
#### Returns
102+
number of entries
103+
93104
#### `public void `[`init`](#class_s_p_i_f_f_s_logger_base_1ad2270960852a999b0340fa4eab50f063)`()`
94105

95106
Initialize the logger.

‎extras/docs/html/_s_p_i_f_f_s_logger_8h.html‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<meta name="generator" content="Doxygen 1.8.14"/>
6+
<meta name="generator" content="Doxygen 1.8.13"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>SPIFFSLogger: src/SPIFFSLogger.h File Reference</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -14,9 +14,8 @@
1414
<script type="text/javascript" src="navtreedata.js"></script>
1515
<script type="text/javascript" src="navtree.js"></script>
1616
<script type="text/javascript">
17-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
1817
$(document).ready(initResizable);
19-
/* @license-end */</script>
18+
</script>
2019
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2120
</head>
2221
<body>
@@ -36,15 +35,14 @@
3635
</table>
3736
</div>
3837
<!-- end header part -->
39-
<!-- Generated by Doxygen 1.8.14 -->
38+
<!-- Generated by Doxygen 1.8.13 -->
4039
<script type="text/javascript" src="menudata.js"></script>
4140
<script type="text/javascript" src="menu.js"></script>
4241
<script type="text/javascript">
43-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
4442
$(function() {
4543
initMenu('',false,false,'search.php','Search');
4644
});
47-
/* @license-end */</script>
45+
</script>
4846
<div id="main-nav"></div>
4947
</div><!-- top -->
5048
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -58,9 +56,7 @@
5856
</div>
5957
</div>
6058
<script type="text/javascript">
61-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6259
$(document).ready(function(){initNavTree('_s_p_i_f_f_s_logger_8h.html','');});
63-
/* @license-end */
6460
</script>
6561
<div id="doc-content">
6662
<div class="header">
@@ -91,7 +87,7 @@
9187
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_s_p_i_f_f_s_logger_8h.html">SPIFFSLogger.h</a></li>
9288
<li class="footer">Generated by
9389
<a href="http://www.doxygen.org/index.html">
94-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
90+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
9591
</ul>
9692
</div>
9793
</body>

‎extras/docs/html/_s_p_i_f_f_s_logger_8h_source.html‎

Lines changed: 15 additions & 15 deletions
Large diffs are not rendered by default.

‎extras/docs/html/_s_p_i_f_f_s_logger_base_8cpp.html‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<meta name="generator" content="Doxygen 1.8.14"/>
6+
<meta name="generator" content="Doxygen 1.8.13"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>SPIFFSLogger: src/SPIFFSLoggerBase.cpp File Reference</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -14,9 +14,8 @@
1414
<script type="text/javascript" src="navtreedata.js"></script>
1515
<script type="text/javascript" src="navtree.js"></script>
1616
<script type="text/javascript">
17-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
1817
$(document).ready(initResizable);
19-
/* @license-end */</script>
18+
</script>
2019
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2120
</head>
2221
<body>
@@ -36,15 +35,14 @@
3635
</table>
3736
</div>
3837
<!-- end header part -->
39-
<!-- Generated by Doxygen 1.8.14 -->
38+
<!-- Generated by Doxygen 1.8.13 -->
4039
<script type="text/javascript" src="menudata.js"></script>
4140
<script type="text/javascript" src="menu.js"></script>
4241
<script type="text/javascript">
43-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
4442
$(function() {
4543
initMenu('',false,false,'search.php','Search');
4644
});
47-
/* @license-end */</script>
45+
</script>
4846
<div id="main-nav"></div>
4947
</div><!-- top -->
5048
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -58,9 +56,7 @@
5856
</div>
5957
</div>
6058
<script type="text/javascript">
61-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6259
$(document).ready(function(){initNavTree('_s_p_i_f_f_s_logger_base_8cpp.html','');});
63-
/* @license-end */
6460
</script>
6561
<div id="doc-content">
6662
<div class="header">
@@ -100,7 +96,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af70a7c4bf0e665786ae633f1
10096
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_s_p_i_f_f_s_logger_base_8cpp.html">SPIFFSLoggerBase.cpp</a></li>
10197
<li class="footer">Generated by
10298
<a href="http://www.doxygen.org/index.html">
103-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
99+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
104100
</ul>
105101
</div>
106102
</body>

‎extras/docs/html/_s_p_i_f_f_s_logger_base_8h.html‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<meta name="generator" content="Doxygen 1.8.14"/>
6+
<meta name="generator" content="Doxygen 1.8.13"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>SPIFFSLogger: src/SPIFFSLoggerBase.h File Reference</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -14,9 +14,8 @@
1414
<script type="text/javascript" src="navtreedata.js"></script>
1515
<script type="text/javascript" src="navtree.js"></script>
1616
<script type="text/javascript">
17-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
1817
$(document).ready(initResizable);
19-
/* @license-end */</script>
18+
</script>
2019
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2120
</head>
2221
<body>
@@ -36,15 +35,14 @@
3635
</table>
3736
</div>
3837
<!-- end header part -->
39-
<!-- Generated by Doxygen 1.8.14 -->
38+
<!-- Generated by Doxygen 1.8.13 -->
4039
<script type="text/javascript" src="menudata.js"></script>
4140
<script type="text/javascript" src="menu.js"></script>
4241
<script type="text/javascript">
43-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
4442
$(function() {
4543
initMenu('',false,false,'search.php','Search');
4644
});
47-
/* @license-end */</script>
45+
</script>
4846
<div id="main-nav"></div>
4947
</div><!-- top -->
5048
<div id="side-nav" class="ui-resizable side-nav-resizable">
@@ -58,9 +56,7 @@
5856
</div>
5957
</div>
6058
<script type="text/javascript">
61-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
6259
$(document).ready(function(){initNavTree('_s_p_i_f_f_s_logger_base_8h.html','');});
63-
/* @license-end */
6460
</script>
6561
<div id="doc-content">
6662
<div class="header">
@@ -90,7 +86,7 @@
9086
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_s_p_i_f_f_s_logger_base_8h.html">SPIFFSLoggerBase.h</a></li>
9187
<li class="footer">Generated by
9288
<a href="http://www.doxygen.org/index.html">
93-
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
89+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
9490
</ul>
9591
</div>
9692
</body>

0 commit comments

Comments
 (0)