Updated documentation for logbank_c

docs/logbank_c/doxygen/html/00__basic__snippets_8c.html

@@ -180,7 +180,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac8417a6c450c6d8730cbd00e
 <div class="line"><span class="lineno">   39</span>}</div>
 <div class="ttc" id="alogbank_8h_html_a610cc9f0715471a7599e7f5f7e40a87f"><div class="ttname"><a href="logbank_8h.html#a610cc9f0715471a7599e7f5f7e40a87f">log_set_level</a></div><div class="ttdeci">int log_set_level(int level)</div><div class="ttdoc">This function configures value for log_level.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8c_source.html#l00395">logbank.c:395</a></div></div>
 <div class="ttc" id="alogbank_8h_html_a6cfcf0d1e54151523d73f747ea51ba99a5b7d4f0d91e50288752648b12035fb35"><div class="ttname"><a href="logbank_8h.html#a6cfcf0d1e54151523d73f747ea51ba99a5b7d4f0d91e50288752648b12035fb35">LOG_DEBUG</a></div><div class="ttdeci">@ LOG_DEBUG</div><div class="ttdoc">recommended for sanity checks (intended for developers)</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00045">logbank.h:45</a></div></div>
-<div class="ttc" id="alogbank_8h_html_acaa1c3fa56061380a29889d703236251"><div class="ttname"><a href="logbank_8h.html#acaa1c3fa56061380a29889d703236251">LOG</a></div><div class="ttdeci">#define LOG(level,...)</div><div class="ttdoc">This is a wrapper for log_this function.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00135">logbank.h:135</a></div></div>
+<div class="ttc" id="alogbank_8h_html_acaa1c3fa56061380a29889d703236251"><div class="ttname"><a href="logbank_8h.html#acaa1c3fa56061380a29889d703236251">LOG</a></div><div class="ttdeci">#define LOG(level,...)</div><div class="ttdoc">This is a wrapper for log_this function.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00139">logbank.h:139</a></div></div>
 </div><!-- fragment -->
 </div>
 </div>
@@ -286,7 +286,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8933223950458147f4e62b01
 <div class="line"><span class="lineno">  120</span>        }</div>
 <div class="line"><span class="lineno">  121</span> </div>
 <div class="line"><span class="lineno">  122</span>        <span class="comment">/* logs are printed here; for Proof of Concept */</span></div>
-<div class="line"><span class="lineno">  123</span>        printf(<span class="stringliteral">&quot;%s&quot;</span>, message);</div>
+<div class="line"><span class="lineno">  123</span>        (void)fprintf(stderr, <span class="stringliteral">&quot;%s&quot;</span>, message);</div>
 <div class="line"><span class="lineno">  124</span>        read_count++;</div>
 <div class="line"><span class="lineno">  125</span>    }</div>
 <div class="line"><span class="lineno">  126</span> </div>

docs/logbank_c/doxygen/html/00__basic__snippets_8c_source.html

@@ -219,7 +219,7 @@
 <div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span>        }</div>
 <div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span> </div>
 <div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span>        <span class="comment">/* logs are printed here; for Proof of Concept */</span></div>
-<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span>        printf(<span class="stringliteral">&quot;%s&quot;</span>, message);</div>
+<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span>        (void)fprintf(stderr, <span class="stringliteral">&quot;%s&quot;</span>, message);</div>
 <div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span>        read_count++;</div>
 <div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span>    }</div>
 <div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span> </div>
@@ -244,7 +244,7 @@
 <div class="ttc" id="alogbank_8h_html_a6cfcf0d1e54151523d73f747ea51ba99aaf5ddc798d2875139456400b5c18897d"><div class="ttname"><a href="logbank_8h.html#a6cfcf0d1e54151523d73f747ea51ba99aaf5ddc798d2875139456400b5c18897d">LOG_WARN</a></div><div class="ttdeci">@ LOG_WARN</div><div class="ttdoc">recommended for warnings (abnormal values)</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00045">logbank.h:45</a></div></div>
 <div class="ttc" id="alogbank_8h_html_a729d70bad9089a4fa7af7191b278d434"><div class="ttname"><a href="logbank_8h.html#a729d70bad9089a4fa7af7191b278d434">LOG_MAX_DATA_LEN</a></div><div class="ttdeci">#define LOG_MAX_DATA_LEN</div><div class="ttdoc">Maximum allowed length for log-message.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00015">logbank.h:15</a></div></div>
 <div class="ttc" id="alogbank_8h_html_a8555559f197dd69f6596aaa3bc97a45e"><div class="ttname"><a href="logbank_8h.html#a8555559f197dd69f6596aaa3bc97a45e">log_use_color</a></div><div class="ttdeci">int log_use_color(int enable)</div><div class="ttdoc">This function is used to enable colors for log-requests being logged on stderr.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8c_source.html#l00449">logbank.c:449</a></div></div>
-<div class="ttc" id="alogbank_8h_html_acaa1c3fa56061380a29889d703236251"><div class="ttname"><a href="logbank_8h.html#acaa1c3fa56061380a29889d703236251">LOG</a></div><div class="ttdeci">#define LOG(level,...)</div><div class="ttdoc">This is a wrapper for log_this function.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00135">logbank.h:135</a></div></div>
+<div class="ttc" id="alogbank_8h_html_acaa1c3fa56061380a29889d703236251"><div class="ttname"><a href="logbank_8h.html#acaa1c3fa56061380a29889d703236251">LOG</a></div><div class="ttdeci">#define LOG(level,...)</div><div class="ttdoc">This is a wrapper for log_this function.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00139">logbank.h:139</a></div></div>
 <div class="ttc" id="alogbank_8h_html_ad09a0b05896754a1b7607c3fccb4839a"><div class="ttname"><a href="logbank_8h.html#ad09a0b05896754a1b7607c3fccb4839a">log_remove_colors</a></div><div class="ttdeci">void log_remove_colors(char *message)</div><div class="ttdoc">This function removes ANSI color codes from message.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8c_source.html#l00497">logbank.c:497</a></div></div>
 <div class="ttc" id="alogbank_8h_html_ad40fb8308e3b7fe972247896b049bbdb"><div class="ttname"><a href="logbank_8h.html#ad40fb8308e3b7fe972247896b049bbdb">log_change_tzone</a></div><div class="ttdeci">void log_change_tzone(int gmt)</div><div class="ttdoc">This function is used to switch between gmt time &amp; local time.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8c_source.html#l00417">logbank.c:417</a></div></div>
 <div class="ttc" id="alogbank_8h_html_af3d39672a440770c16db7efe588ff1b8"><div class="ttname"><a href="logbank_8h.html#af3d39672a440770c16db7efe588ff1b8">log_retrieve</a></div><div class="ttdeci">int log_retrieve(char *message, size_t size)</div><div class="ttdoc">This function is used to retrieve oldest available log-message from log_queue.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8c_source.html#l00511">logbank.c:511</a></div></div>

docs/logbank_c/doxygen/html/globals.html

@@ -150,7 +150,7 @@ <h3><a id="index_l" name="index_l"></a>- l -</h3><ul>
 
 <h3><a id="index_m" name="index_m"></a>- m -</h3><ul>
 <li>main()&#160;:&#160;<a class="el" href="test__runner_8c.html#a840291bc02cba5474a4cb46a9b9566fe">test_runner.c</a></li>
-<li>make_queue_full()&#160;:&#160;<a class="el" href="test05__retrieve_8c.html#a930023e7c22fad36ee2a2c7d97980057">test05_retrieve.c</a></li>
+<li>make_queue_full()&#160;:&#160;<a class="el" href="test05__retrieve_8c.html#a0e70e2d995d3da3c10487c5ae0dbe076">test05_retrieve.c</a></li>
 </ul>
 
 

docs/logbank_c/doxygen/html/globals_func.html

@@ -97,7 +97,7 @@ <h3><a id="index_l" name="index_l"></a>- l -</h3><ul>
 
 <h3><a id="index_m" name="index_m"></a>- m -</h3><ul>
 <li>main()&#160;:&#160;<a class="el" href="test__runner_8c.html#a840291bc02cba5474a4cb46a9b9566fe">test_runner.c</a></li>
-<li>make_queue_full()&#160;:&#160;<a class="el" href="test05__retrieve_8c.html#a930023e7c22fad36ee2a2c7d97980057">test05_retrieve.c</a></li>
+<li>make_queue_full()&#160;:&#160;<a class="el" href="test05__retrieve_8c.html#a0e70e2d995d3da3c10487c5ae0dbe076">test05_retrieve.c</a></li>
 </ul>
 
 

docs/logbank_c/doxygen/html/logbank_8c_source.html

@@ -493,14 +493,14 @@
 <div class="ttc" id="alogbank_8c_html_af908196e407bb67394664c7b0d5999b8"><div class="ttname"><a href="logbank_8c.html#af908196e407bb67394664c7b0d5999b8">LOG_TIME_LEN</a></div><div class="ttdeci">#define LOG_TIME_LEN</div><div class="ttdoc">Calculated length for specified time format + 1 for string termination.</div><div class="ttdef"><b>Definition</b> <a href="#l00037">logbank.c:37</a></div></div>
 <div class="ttc" id="alogbank_8h_html"><div class="ttname"><a href="logbank_8h.html">logbank.h</a></div></div>
 <div class="ttc" id="alogbank_8h_html_a0b87e0d3bf5853bcbb0b66a7c48fdc05"><div class="ttname"><a href="logbank_8h.html#a0b87e0d3bf5853bcbb0b66a7c48fdc05">LOG_LEVEL</a></div><div class="ttdeci">#define LOG_LEVEL</div><div class="ttdoc">Default value for log_level.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00061">logbank.h:61</a></div></div>
-<div class="ttc" id="alogbank_8h_html_a2671a6aa5ca95c2a6c3fd0032e7880d5"><div class="ttname"><a href="logbank_8h.html#a2671a6aa5ca95c2a6c3fd0032e7880d5">LOG_COLOR</a></div><div class="ttdeci">#define LOG_COLOR</div><div class="ttdoc">Default value of log_color used for stderr.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00125">logbank.h:125</a></div></div>
+<div class="ttc" id="alogbank_8h_html_a2671a6aa5ca95c2a6c3fd0032e7880d5"><div class="ttname"><a href="logbank_8h.html#a2671a6aa5ca95c2a6c3fd0032e7880d5">LOG_COLOR</a></div><div class="ttdeci">#define LOG_COLOR</div><div class="ttdoc">Default value of log_color used for stderr.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00129">logbank.h:129</a></div></div>
 <div class="ttc" id="alogbank_8h_html_a4caacfae62d7eef49d49b5498679f136"><div class="ttname"><a href="logbank_8h.html#a4caacfae62d7eef49d49b5498679f136">LOG_RETRIEVE_QUEUE_LEN</a></div><div class="ttdeci">#define LOG_RETRIEVE_QUEUE_LEN</div><div class="ttdoc">Length of internal log_queue which is used to retrieve recent logs.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00021">logbank.h:21</a></div></div>
-<div class="ttc" id="alogbank_8h_html_a5f56d981e5b55df4bee5c7a5b6b44007"><div class="ttname"><a href="logbank_8h.html#a5f56d981e5b55df4bee5c7a5b6b44007">LOG_DATESTAMP</a></div><div class="ttdeci">#define LOG_DATESTAMP</div><div class="ttdoc">Default value of log_datestamp.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00108">logbank.h:108</a></div></div>
+<div class="ttc" id="alogbank_8h_html_a5f56d981e5b55df4bee5c7a5b6b44007"><div class="ttname"><a href="logbank_8h.html#a5f56d981e5b55df4bee5c7a5b6b44007">LOG_DATESTAMP</a></div><div class="ttdeci">#define LOG_DATESTAMP</div><div class="ttdoc">Default value of log_datestamp.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00112">logbank.h:112</a></div></div>
 <div class="ttc" id="alogbank_8h_html_a6cfcf0d1e54151523d73f747ea51ba99a1d2ddc2d110200d6c342359bd0e19a3c"><div class="ttname"><a href="logbank_8h.html#a6cfcf0d1e54151523d73f747ea51ba99a1d2ddc2d110200d6c342359bd0e19a3c">LOG_INFO</a></div><div class="ttdeci">@ LOG_INFO</div><div class="ttdoc">recommended for general informations (code flow)</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00045">logbank.h:45</a></div></div>
 <div class="ttc" id="alogbank_8h_html_a6cfcf0d1e54151523d73f747ea51ba99a586842e9a80356d3447729860d4417bc"><div class="ttname"><a href="logbank_8h.html#a6cfcf0d1e54151523d73f747ea51ba99a586842e9a80356d3447729860d4417bc">LOG_FATAL</a></div><div class="ttdeci">@ LOG_FATAL</div><div class="ttdoc">recommended for blockers (system failure: can not continue)</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00045">logbank.h:45</a></div></div>
 <div class="ttc" id="alogbank_8h_html_a6cfcf0d1e54151523d73f747ea51ba99aaf5ddc798d2875139456400b5c18897d"><div class="ttname"><a href="logbank_8h.html#a6cfcf0d1e54151523d73f747ea51ba99aaf5ddc798d2875139456400b5c18897d">LOG_WARN</a></div><div class="ttdeci">@ LOG_WARN</div><div class="ttdoc">recommended for warnings (abnormal values)</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00045">logbank.h:45</a></div></div>
 <div class="ttc" id="alogbank_8h_html_a729d70bad9089a4fa7af7191b278d434"><div class="ttname"><a href="logbank_8h.html#a729d70bad9089a4fa7af7191b278d434">LOG_MAX_DATA_LEN</a></div><div class="ttdeci">#define LOG_MAX_DATA_LEN</div><div class="ttdoc">Maximum allowed length for log-message.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00015">logbank.h:15</a></div></div>
-<div class="ttc" id="alogbank_8h_html_abc368d21141fd7f00227bbe05c8a476c"><div class="ttname"><a href="logbank_8h.html#abc368d21141fd7f00227bbe05c8a476c">LOG_TIMESTAMP</a></div><div class="ttdeci">#define LOG_TIMESTAMP</div><div class="ttdoc">Default value of log_timestamp.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00116">logbank.h:116</a></div></div>
+<div class="ttc" id="alogbank_8h_html_abc368d21141fd7f00227bbe05c8a476c"><div class="ttname"><a href="logbank_8h.html#abc368d21141fd7f00227bbe05c8a476c">LOG_TIMESTAMP</a></div><div class="ttdeci">#define LOG_TIMESTAMP</div><div class="ttdoc">Default value of log_timestamp.</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00120">logbank.h:120</a></div></div>
 <div class="ttc" id="astructlog__locate__t_html"><div class="ttname"><a href="structlog__locate__t.html">log_locate_t</a></div><div class="ttdoc">type for location parameters of log-request</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00079">logbank.h:79</a></div></div>
 <div class="ttc" id="astructlog__locate__t_html_a0b90d39ff2c7402e79dc2d495734b2a2"><div class="ttname"><a href="structlog__locate__t.html#a0b90d39ff2c7402e79dc2d495734b2a2">log_locate_t::line</a></div><div class="ttdeci">int line</div><div class="ttdoc">line number</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00082">logbank.h:82</a></div></div>
 <div class="ttc" id="astructlog__locate__t_html_a0c90ea314fda6ca6929a7a3d9bfc221e"><div class="ttname"><a href="structlog__locate__t.html#a0c90ea314fda6ca6929a7a3d9bfc221e">log_locate_t::func</a></div><div class="ttdeci">const char * func</div><div class="ttdoc">function name</div><div class="ttdef"><b>Definition</b> <a href="logbank_8h_source.html#l00080">logbank.h:80</a></div></div>