Skip to content

Commit

Permalink
Updated documentation for logbank_c
Browse files Browse the repository at this point in the history
  • Loading branch information
khushal-banks committed May 13, 2024
1 parent 58788ee commit a4ded2b
Show file tree
Hide file tree
Showing 38 changed files with 595 additions and 202 deletions.
10 changes: 10 additions & 0 deletions docs/logbank_c/doxygen/html/00__basic__snippets_8c.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
<tr class="memdesc:ac8417a6c450c6d8730cbd00e3c7823ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to print a log with LOG_DEBUG level. <br /></td></tr>
<tr class="separator:ac8417a6c450c6d8730cbd00e3c7823ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a778bef23770ae6204d46ce12101b3a41" id="r_a778bef23770ae6204d46ce12101b3a41"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a778bef23770ae6204d46ce12101b3a41">snippet_stamps</a> (int gmt)</td></tr>
<tr class="memdesc:a778bef23770ae6204d46ce12101b3a41"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function prints all different combination of stamps for current time zone. <br /></td></tr>
<tr class="separator:a778bef23770ae6204d46ce12101b3a41"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
Expand Down Expand Up @@ -226,6 +227,15 @@ <h2 class="memtitle"><span class="permalink"><a href="#a778bef23770ae6204d46ce12
</table>
</div><div class="memdoc">

<p>This function prints all different combination of stamps for current time zone. </p>
<p>This enables/disables date/time stamps and prints sample logs Finally, stamps config is reverted to previous settings</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">gmt</td><td>set gmt to 1 or 0 in order to use gmt time or local time respectively </td></tr>
</table>
</dd>
</dl>

<p class="definition">Definition at line <a class="el" href="00__basic__snippets_8c_source.html#l00042">42</a> of file <a class="el" href="00__basic__snippets_8c_source.html">00_basic_snippets.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 42</span> {</div>
<div class="line"><span class="lineno"> 43</span> </div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00042" data-start="{" data-end="}">
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="snippets__header_8h.html#a778bef23770ae6204d46ce12101b3a41"> 42</a></span><a class="code hl_function" href="00__basic__snippets_8c.html#a778bef23770ae6204d46ce12101b3a41">snippet_stamps</a>(<span class="keywordtype">int</span> gmt) {</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="snippets__header_8h.html#a6620b9789be2d996cf2f066ac5645dd4"> 42</a></span><a class="code hl_function" href="00__basic__snippets_8c.html#a778bef23770ae6204d46ce12101b3a41">snippet_stamps</a>(<span class="keywordtype">int</span> gmt) {</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="comment">/* Configure time-zone */</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_function" href="logbank_8h.html#ad40fb8308e3b7fe972247896b049bbdb">log_change_tzone</a>(gmt);</div>
Expand Down Expand Up @@ -171,7 +171,7 @@
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>}</div>
</div>
<div class="ttc" id="a00__basic__snippets_8c_html_a402ebc414f8fe9566959ffd190bd9d29"><div class="ttname"><a href="00__basic__snippets_8c.html#a402ebc414f8fe9566959ffd190bd9d29">snippet_sample_logs</a></div><div class="ttdeci">void snippet_sample_logs(void)</div><div class="ttdoc">This function is used to print sample logs with current log_level.</div><div class="ttdef"><b>Definition</b> <a href="#l00004">00_basic_snippets.c:4</a></div></div>
<div class="ttc" id="a00__basic__snippets_8c_html_a778bef23770ae6204d46ce12101b3a41"><div class="ttname"><a href="00__basic__snippets_8c.html#a778bef23770ae6204d46ce12101b3a41">snippet_stamps</a></div><div class="ttdeci">void snippet_stamps(int gmt)</div><div class="ttdef"><b>Definition</b> <a href="#l00042">00_basic_snippets.c:42</a></div></div>
<div class="ttc" id="a00__basic__snippets_8c_html_a778bef23770ae6204d46ce12101b3a41"><div class="ttname"><a href="00__basic__snippets_8c.html#a778bef23770ae6204d46ce12101b3a41">snippet_stamps</a></div><div class="ttdeci">void snippet_stamps(int gmt)</div><div class="ttdoc">This function prints all different combination of stamps for current time zone.</div><div class="ttdef"><b>Definition</b> <a href="#l00042">00_basic_snippets.c:42</a></div></div>
<div class="ttc" id="a00__basic__snippets_8c_html_a8025a766e95a5e7a457090e9608095e7"><div class="ttname"><a href="00__basic__snippets_8c.html#a8025a766e95a5e7a457090e9608095e7">snippet_priority_level</a></div><div class="ttdeci">void snippet_priority_level(int level)</div><div class="ttdoc">This function is used to print sample logs with a new log_level And revert back to old priority level...</div><div class="ttdef"><b>Definition</b> <a href="#l00020">00_basic_snippets.c:20</a></div></div>
<div class="ttc" id="a00__basic__snippets_8c_html_ac8417a6c450c6d8730cbd00e3c7823ed"><div class="ttname"><a href="00__basic__snippets_8c.html#ac8417a6c450c6d8730cbd00e3c7823ed">snippet_location</a></div><div class="ttdeci">void snippet_location(void)</div><div class="ttdoc">This function is used to print a log with LOG_DEBUG level.</div><div class="ttdef"><b>Definition</b> <a href="#l00031">00_basic_snippets.c:31</a></div></div>
<div class="ttc" id="alogbank_8h_html_a12a859a61c62ad187ebfb0ea187519b4"><div class="ttname"><a href="logbank_8h.html#a12a859a61c62ad187ebfb0ea187519b4">log_use_datestamp</a></div><div class="ttdeci">int log_use_datestamp(int enable)</div><div class="ttdoc">This function is used to enable date stamps for every log-request at run-time.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8c_source.html#l00160">logbank.c:160</a></div></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/logbank_c/doxygen/html/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structLOG__LOCATE.html" target="_self">LOG_LOCATE</a></td><td class="desc">Type for location parameters of log-request </td></tr>
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structlog__locate__t.html" target="_self">log_locate_t</a></td><td class="desc">Type for location parameters of log-request </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
2 changes: 1 addition & 1 deletion docs/logbank_c/doxygen/html/classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<div class="classindex">
<dl class="classindex even">
<dt class="alphachar"><a id="letter_L" name="letter_L">L</a></dt>
<dd><a class="el" href="structLOG__LOCATE.html">LOG_LOCATE</a></dd></dl>
<dd><a class="el" href="structlog__locate__t.html">log_locate_t</a></dd></dl>
</div>
</div><!-- contents -->
<!-- start footer part -->
Expand Down
5 changes: 2 additions & 3 deletions docs/logbank_c/doxygen/html/doxygen_crawl.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@
<a href="md_CHANGE__LIST.html"/>
<a href="md_CODE__OF__CONDUCT.html"/>
<a href="md_CONTRIBUTING.html"/>
<a href="structLOG__LOCATE.html"/>
<a href="structLOG__LOCATE-members.html"/>
<a href="structlog__locate__t.html"/>
<a href="structlog__locate__t-members.html"/>
<a href="dir_c420d111752b94fbccad56a8e545f3e4.html"/>
<a href="dir_6e569d778d6e0edb99b470cd936bda81.html"/>
<a href="dir_e725f4cf7830025c2724f6f641ba783e.html"/>
Expand Down Expand Up @@ -63,7 +63,6 @@
<a href="globals_func.html"/>
<a href="globals_func.html"/>
<a href="globals_vars.html"/>
<a href="globals_type.html"/>
<a href="globals_enum.html"/>
<a href="globals_eval.html"/>
<a href="globals_defs.html"/>
Expand Down
6 changes: 3 additions & 3 deletions docs/logbank_c/doxygen/html/functions.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@

<div class="contents">
<div class="textblock">Here is a list of all class members with links to the classes they belong to:</div><ul>
<li>file&#160;:&#160;<a class="el" href="structLOG__LOCATE.html#a0fbfa81e786eb5dd01a6b48d7495a674">LOG_LOCATE</a></li>
<li>func&#160;:&#160;<a class="el" href="structLOG__LOCATE.html#a1630afacaa2ba2e0b776ed6a8c99d2f7">LOG_LOCATE</a></li>
<li>line&#160;:&#160;<a class="el" href="structLOG__LOCATE.html#a986a73ab6451c2154a5d926adc3efa18">LOG_LOCATE</a></li>
<li>file&#160;:&#160;<a class="el" href="structlog__locate__t.html#ad00d25abaa1a72cd0735c44774978978">log_locate_t</a></li>
<li>func&#160;:&#160;<a class="el" href="structlog__locate__t.html#a0c90ea314fda6ca6929a7a3d9bfc221e">log_locate_t</a></li>
<li>line&#160;:&#160;<a class="el" href="structlog__locate__t.html#a0b90d39ff2c7402e79dc2d495734b2a2">log_locate_t</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
Expand Down
6 changes: 3 additions & 3 deletions docs/logbank_c/doxygen/html/functions_vars.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@

<div class="contents">
<div class="textblock">Here is a list of all variables with links to the classes they belong to:</div><ul>
<li>file&#160;:&#160;<a class="el" href="structLOG__LOCATE.html#a0fbfa81e786eb5dd01a6b48d7495a674">LOG_LOCATE</a></li>
<li>func&#160;:&#160;<a class="el" href="structLOG__LOCATE.html#a1630afacaa2ba2e0b776ed6a8c99d2f7">LOG_LOCATE</a></li>
<li>line&#160;:&#160;<a class="el" href="structLOG__LOCATE.html#a986a73ab6451c2154a5d926adc3efa18">LOG_LOCATE</a></li>
<li>file&#160;:&#160;<a class="el" href="structlog__locate__t.html#ad00d25abaa1a72cd0735c44774978978">log_locate_t</a></li>
<li>func&#160;:&#160;<a class="el" href="structlog__locate__t.html#a0c90ea314fda6ca6929a7a3d9bfc221e">log_locate_t</a></li>
<li>line&#160;:&#160;<a class="el" href="structlog__locate__t.html#a0b90d39ff2c7402e79dc2d495734b2a2">log_locate_t</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
Expand Down
9 changes: 4 additions & 5 deletions docs/logbank_c/doxygen/html/globals.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,19 +89,18 @@ <h3><a id="index_l" name="index_l"></a>- l -</h3><ul>
<li>LOG_DEBUG&#160;:&#160;<a class="el" href="logbank_8h.html#a6cfcf0d1e54151523d73f747ea51ba99a5b7d4f0d91e50288752648b12035fb35">logbank.h</a></li>
<li>LOG_ERROR&#160;:&#160;<a class="el" href="logbank_8h.html#a6cfcf0d1e54151523d73f747ea51ba99a3a32823436abb3c3442b6bf3f70ec9b6">logbank.h</a></li>
<li>LOG_FATAL&#160;:&#160;<a class="el" href="logbank_8h.html#a6cfcf0d1e54151523d73f747ea51ba99a586842e9a80356d3447729860d4417bc">logbank.h</a></li>
<li>log_get_default_level()&#160;:&#160;<a class="el" href="logbank_8c.html#a5e49b5594c4aed69441bc2b4b0e8e0e7">logbank.c</a>, <a class="el" href="logbank_8h.html#a0235f5d0111c171178d8cfaeedc8c0af">logbank.h</a></li>
<li>log_get_default_level()&#160;:&#160;<a class="el" href="logbank_8h.html#a0235f5d0111c171178d8cfaeedc8c0af">logbank.h</a>, <a class="el" href="logbank_8c.html#a5e49b5594c4aed69441bc2b4b0e8e0e7">logbank.c</a></li>
<li>log_get_level()&#160;:&#160;<a class="el" href="logbank_8h.html#a96925309953d5ca93fc4e5b20a557ffb">logbank.h</a>, <a class="el" href="logbank_8c.html#ab53553042bb3122475a03674bd689d5a">logbank.c</a></li>
<li>log_get_levelname()&#160;:&#160;<a class="el" href="logbank_8h.html#a2d07ede7701c6fd6731213b5f85f6d29">logbank.h</a>, <a class="el" href="logbank_8c.html#a2f37fc38d4885ae4fd5f499787e5f550">logbank.c</a></li>
<li>LOG_INFO&#160;:&#160;<a class="el" href="logbank_8h.html#a6cfcf0d1e54151523d73f747ea51ba99a1d2ddc2d110200d6c342359bd0e19a3c">logbank.h</a></li>
<li>LOG_ISSUE&#160;:&#160;<a class="el" href="logbank_8h.html#a6cfcf0d1e54151523d73f747ea51ba99a31029d55440c470cf8cdbb42787e34fd">logbank.h</a></li>
<li>log_level&#160;:&#160;<a class="el" href="logbank_8c.html#ac91d55174d383848b976a34de843748e">logbank.c</a></li>
<li>LOG_LEVEL&#160;:&#160;<a class="el" href="logbank_8h.html#a0b87e0d3bf5853bcbb0b66a7c48fdc05">logbank.h</a></li>
<li>log_level&#160;:&#160;<a class="el" href="logbank_8c.html#ac91d55174d383848b976a34de843748e">logbank.c</a></li>
<li>LOG_LEVELS&#160;:&#160;<a class="el" href="logbank_8h.html#a6cfcf0d1e54151523d73f747ea51ba99">logbank.h</a></li>
<li>log_locate_t&#160;:&#160;<a class="el" href="logbank_8h.html#a390e284dca17e1c1eb5106e82645c11d">logbank.h</a></li>
<li>LOG_LOCATION&#160;:&#160;<a class="el" href="logbank_8h.html#af871188d88e45fc10c15cbe2c90545b1">logbank.h</a></li>
<li>log_set_level()&#160;:&#160;<a class="el" href="logbank_8h.html#a610cc9f0715471a7599e7f5f7e40a87f">logbank.h</a>, <a class="el" href="logbank_8c.html#af0d39913e824d4d0aef7513b284ea289">logbank.c</a></li>
<li>log_stamp_collector()&#160;:&#160;<a class="el" href="logbank_8c.html#a7428ec2d45d3df3bbb27094a8f8d585a">logbank.c</a></li>
<li>log_this()&#160;:&#160;<a class="el" href="logbank_8h.html#af3ead88ac759015175f6824b3a4bb882">logbank.h</a>, <a class="el" href="logbank_8c.html#af3ead88ac759015175f6824b3a4bb882">logbank.c</a></li>
<li>log_this()&#160;:&#160;<a class="el" href="logbank_8h.html#a9618e8e44960252c699aea9fc3fc49bc">logbank.h</a>, <a class="el" href="logbank_8c.html#af3ead88ac759015175f6824b3a4bb882">logbank.c</a></li>
<li>LOG_TIME_12HR&#160;:&#160;<a class="el" href="logbank_8c.html#a973d1a977f445cb8c1d0aeb30f0f119d">logbank.c</a></li>
<li>LOG_TIME_24HR&#160;:&#160;<a class="el" href="logbank_8c.html#a49a22f43182bf7e7877154898a11c736">logbank.c</a></li>
<li>log_time_fn&#160;:&#160;<a class="el" href="logbank_8c.html#aecd1c33eda8dadb496cecee02527b6a3">logbank.c</a></li>
Expand All @@ -124,7 +123,7 @@ <h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>snippet_location()&#160;:&#160;<a class="el" href="snippets__header_8h.html#aa666538ec330550637743b7ce054fa51">snippets_header.h</a>, <a class="el" href="00__basic__snippets_8c.html#ac8417a6c450c6d8730cbd00e3c7823ed">00_basic_snippets.c</a></li>
<li>snippet_priority_level()&#160;:&#160;<a class="el" href="snippets__header_8h.html#a18e02812408dc4afb5b4e52663f59d5f">snippets_header.h</a>, <a class="el" href="00__basic__snippets_8c.html#a8025a766e95a5e7a457090e9608095e7">00_basic_snippets.c</a></li>
<li>snippet_sample_logs()&#160;:&#160;<a class="el" href="snippets__header_8h.html#a8c7fafe7294357eb39dd5de9cbf216ab">snippets_header.h</a>, <a class="el" href="00__basic__snippets_8c.html#a402ebc414f8fe9566959ffd190bd9d29">00_basic_snippets.c</a></li>
<li>snippet_stamps()&#160;:&#160;<a class="el" href="snippets__header_8h.html#a778bef23770ae6204d46ce12101b3a41">snippets_header.h</a>, <a class="el" href="00__basic__snippets_8c.html#a778bef23770ae6204d46ce12101b3a41">00_basic_snippets.c</a></li>
<li>snippet_stamps()&#160;:&#160;<a class="el" href="snippets__header_8h.html#a6620b9789be2d996cf2f066ac5645dd4">snippets_header.h</a>, <a class="el" href="00__basic__snippets_8c.html#a778bef23770ae6204d46ce12101b3a41">00_basic_snippets.c</a></li>
</ul>


Expand Down
4 changes: 2 additions & 2 deletions docs/logbank_c/doxygen/html/globals_func.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ <h3><a id="index_l" name="index_l"></a>- l -</h3><ul>
<li>log_get_levelname()&#160;:&#160;<a class="el" href="logbank_8h.html#a2d07ede7701c6fd6731213b5f85f6d29">logbank.h</a>, <a class="el" href="logbank_8c.html#a2f37fc38d4885ae4fd5f499787e5f550">logbank.c</a></li>
<li>log_set_level()&#160;:&#160;<a class="el" href="logbank_8h.html#a610cc9f0715471a7599e7f5f7e40a87f">logbank.h</a>, <a class="el" href="logbank_8c.html#af0d39913e824d4d0aef7513b284ea289">logbank.c</a></li>
<li>log_stamp_collector()&#160;:&#160;<a class="el" href="logbank_8c.html#a7428ec2d45d3df3bbb27094a8f8d585a">logbank.c</a></li>
<li>log_this()&#160;:&#160;<a class="el" href="logbank_8h.html#af3ead88ac759015175f6824b3a4bb882">logbank.h</a>, <a class="el" href="logbank_8c.html#af3ead88ac759015175f6824b3a4bb882">logbank.c</a></li>
<li>log_this()&#160;:&#160;<a class="el" href="logbank_8h.html#a9618e8e44960252c699aea9fc3fc49bc">logbank.h</a>, <a class="el" href="logbank_8c.html#af3ead88ac759015175f6824b3a4bb882">logbank.c</a></li>
<li>log_use_datestamp()&#160;:&#160;<a class="el" href="logbank_8h.html#a12a859a61c62ad187ebfb0ea187519b4">logbank.h</a>, <a class="el" href="logbank_8c.html#abfe2b67a3b61f6ca5ac29458f1a6fa20">logbank.c</a></li>
<li>log_use_timestamp()&#160;:&#160;<a class="el" href="logbank_8h.html#a2cbc919241ff3ace24da6e8a3907ba01">logbank.h</a>, <a class="el" href="logbank_8c.html#a1c3d0c234139eef0ecdd76c379bd2622">logbank.c</a></li>
</ul>
Expand All @@ -96,7 +96,7 @@ <h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>snippet_location()&#160;:&#160;<a class="el" href="snippets__header_8h.html#aa666538ec330550637743b7ce054fa51">snippets_header.h</a>, <a class="el" href="00__basic__snippets_8c.html#ac8417a6c450c6d8730cbd00e3c7823ed">00_basic_snippets.c</a></li>
<li>snippet_priority_level()&#160;:&#160;<a class="el" href="snippets__header_8h.html#a18e02812408dc4afb5b4e52663f59d5f">snippets_header.h</a>, <a class="el" href="00__basic__snippets_8c.html#a8025a766e95a5e7a457090e9608095e7">00_basic_snippets.c</a></li>
<li>snippet_sample_logs()&#160;:&#160;<a class="el" href="snippets__header_8h.html#a8c7fafe7294357eb39dd5de9cbf216ab">snippets_header.h</a>, <a class="el" href="00__basic__snippets_8c.html#a402ebc414f8fe9566959ffd190bd9d29">00_basic_snippets.c</a></li>
<li>snippet_stamps()&#160;:&#160;<a class="el" href="snippets__header_8h.html#a778bef23770ae6204d46ce12101b3a41">snippets_header.h</a>, <a class="el" href="00__basic__snippets_8c.html#a778bef23770ae6204d46ce12101b3a41">00_basic_snippets.c</a></li>
<li>snippet_stamps()&#160;:&#160;<a class="el" href="snippets__header_8h.html#a6620b9789be2d996cf2f066ac5645dd4">snippets_header.h</a>, <a class="el" href="00__basic__snippets_8c.html#a778bef23770ae6204d46ce12101b3a41">00_basic_snippets.c</a></li>
</ul>


Expand Down
Loading

0 comments on commit a4ded2b

Please sign in to comment.