nojhan/clutchlog
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update(docs)

Browse source
This commit is contained in:
Johann Dreo 2024-09-10 16:21:54 +02:00
commit c9cb73990d
213 changed files with 10044 additions and 6276 deletions
Download patch file Download diff file Expand all files Collapse all files

196
docs/group___default_config.html
View file

@ -2,8 +2,8 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>clutchlog: Default configuration management</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@ -24,11 +24,10 @@
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="clutchlog_logo.svg"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">clutchlog
&#160;<span id="projectnumber">0.16</span>
<td id="projectalign">
<div id="projectname">clutchlog<span id="projectnumber">&#160;0.17</span>
</div>
</td>
</tr>
@ -36,21 +35,22 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
@ -64,7 +64,7 @@ $(function() {
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group___default_config.html',''); initResizable(); });
/* @license-end */
</script>
@ -86,54 +86,168 @@ $(document).ready(function(){initNavTree('group___default_config.html',''); init
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Default configuration management</div> </div>
<div class="headertitle"><div class="title">Default configuration management</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga8564be479b948ee3052b61783c66d415"><td class="memItemLeft" align="right" valign="top"><a id="ga8564be479b948ee3052b61783c66d415"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___default_config.html#ga8564be479b948ee3052b61783c66d415">CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG</a>&#160;&#160;&#160;clutchlog::level::progress</td></tr>
<tr class="memdesc:ga8564be479b948ee3052b61783c66d415"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default level over which calls to the logger are optimized out when NDEBUG is defined. <br /></td></tr>
<tr class="memitem:ga8564be479b948ee3052b61783c66d415"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___default_config.html#ga8564be479b948ee3052b61783c66d415">CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG</a>&#160;&#160;&#160;clutchlog::level::progress</td></tr>
<tr class="memdesc:ga8564be479b948ee3052b61783c66d415"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default level over which calls to the logger are optimized out when NDEBUG is defined. <a href="group___default_config.html#ga8564be479b948ee3052b61783c66d415">More...</a><br /></td></tr>
<tr class="separator:ga8564be479b948ee3052b61783c66d415"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Default configuration members</h2></td></tr>
<tr class="memitem:ga524c16f280d92ee8ab683162c9ce01fa"><td class="memItemLeft" align="right" valign="top"><a id="ga524c16f280d92ee8ab683162c9ce01fa"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___default_config.html#ga524c16f280d92ee8ab683162c9ce01fa">CLUTCHLOG_DEFAULT_FORMAT</a>&#160;&#160;&#160;&quot;{level_letter} {msg}\t\t\t\t\t{func} @ {file}:{line}\n&quot;</td></tr>
<tr class="memdesc:ga524c16f280d92ee8ab683162c9ce01fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compile-time default format of the messages (debug mode: with absolute location). <br /></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader">Default configuration members</h2></td></tr>
<tr class="memitem:ga524c16f280d92ee8ab683162c9ce01fa"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___default_config.html#ga524c16f280d92ee8ab683162c9ce01fa">CLUTCHLOG_DEFAULT_FORMAT</a>&#160;&#160;&#160;&quot;{level_letter} {msg}\t\t\t\t\t{func} @ {file}:{line}\n&quot;</td></tr>
<tr class="separator:ga524c16f280d92ee8ab683162c9ce01fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga27b613c6727857a7cbcd0165d862034e"><td class="memItemLeft" align="right" valign="top"><a id="ga27b613c6727857a7cbcd0165d862034e"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___default_config.html#ga27b613c6727857a7cbcd0165d862034e">CLUTCHDUMP_DEFAULT_FORMAT</a>&#160;&#160;&#160;&quot;# {level} in {func} @ {file}:{line}&quot;</td></tr>
<tr class="memdesc:ga27b613c6727857a7cbcd0165d862034e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compile-time default format of the comment line in file dump. <br /></td></tr>
<tr class="memitem:ga27b613c6727857a7cbcd0165d862034e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___default_config.html#ga27b613c6727857a7cbcd0165d862034e">CLUTCHDUMP_DEFAULT_FORMAT</a>&#160;&#160;&#160;&quot;# {level} in {func} @ {file}:{line}&quot;</td></tr>
<tr class="memdesc:ga27b613c6727857a7cbcd0165d862034e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compile-time default format of the comment line in file dump. <a href="group___default_config.html#ga27b613c6727857a7cbcd0165d862034e">More...</a><br /></td></tr>
<tr class="separator:ga27b613c6727857a7cbcd0165d862034e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga54d29e956575e1c731eab5406135c5df"><td class="memItemLeft" align="right" valign="top"><a id="ga54d29e956575e1c731eab5406135c5df"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___default_config.html#ga54d29e956575e1c731eab5406135c5df">CLUTCHDUMP_DEFAULT_SEP</a>&#160;&#160;&#160;&quot;\n&quot;</td></tr>
<tr class="memdesc:ga54d29e956575e1c731eab5406135c5df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compile-time default item separator for dump. <br /></td></tr>
<tr class="memitem:ga54d29e956575e1c731eab5406135c5df"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___default_config.html#ga54d29e956575e1c731eab5406135c5df">CLUTCHDUMP_DEFAULT_SEP</a>&#160;&#160;&#160;&quot;\n&quot;</td></tr>
<tr class="memdesc:ga54d29e956575e1c731eab5406135c5df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compile-time default item separator for dump. <a href="group___default_config.html#ga54d29e956575e1c731eab5406135c5df">More...</a><br /></td></tr>
<tr class="separator:ga54d29e956575e1c731eab5406135c5df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga45c4c964fad4ad1641d5c9c28c4645b9"><td class="memItemLeft" align="right" valign="top"><a id="ga45c4c964fad4ad1641d5c9c28c4645b9"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___default_config.html#ga45c4c964fad4ad1641d5c9c28c4645b9">CLUTCHLOG_DEFAULT_DEPTH_MARK</a>&#160;&#160;&#160;&quot;&gt;&quot;</td></tr>
<tr class="memdesc:ga45c4c964fad4ad1641d5c9c28c4645b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compile-time default mark for stack depth. <br /></td></tr>
<tr class="memitem:ga45c4c964fad4ad1641d5c9c28c4645b9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___default_config.html#ga45c4c964fad4ad1641d5c9c28c4645b9">CLUTCHLOG_DEFAULT_DEPTH_MARK</a>&#160;&#160;&#160;&quot;&gt;&quot;</td></tr>
<tr class="memdesc:ga45c4c964fad4ad1641d5c9c28c4645b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compile-time default mark for stack depth. <a href="group___default_config.html#ga45c4c964fad4ad1641d5c9c28c4645b9">More...</a><br /></td></tr>
<tr class="separator:ga45c4c964fad4ad1641d5c9c28c4645b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga98f30d814d4913a8a7c93a8793f49adf"><td class="memItemLeft" align="right" valign="top"><a id="ga98f30d814d4913a8a7c93a8793f49adf"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___default_config.html#ga98f30d814d4913a8a7c93a8793f49adf">CLUTCHLOG_STRIP_CALLS</a>&#160;&#160;&#160;5</td></tr>
<tr class="memdesc:ga98f30d814d4913a8a7c93a8793f49adf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compile-time number of call stack levels to remove from depth display by default. <br /></td></tr>
<tr class="memitem:ga98f30d814d4913a8a7c93a8793f49adf"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___default_config.html#ga98f30d814d4913a8a7c93a8793f49adf">CLUTCHLOG_STRIP_CALLS</a>&#160;&#160;&#160;5</td></tr>
<tr class="memdesc:ga98f30d814d4913a8a7c93a8793f49adf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compile-time number of call stack levels to remove from depth display by default. <a href="group___default_config.html#ga98f30d814d4913a8a7c93a8793f49adf">More...</a><br /></td></tr>
<tr class="separator:ga98f30d814d4913a8a7c93a8793f49adf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4eda0c1bfded5df89351b8ce8b9c2805"><td class="memItemLeft" align="right" valign="top"><a id="ga4eda0c1bfded5df89351b8ce8b9c2805"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___default_config.html#ga4eda0c1bfded5df89351b8ce8b9c2805">CLUTCHLOG_DEFAULT_HFILL_MARK</a>&#160;&#160;&#160;'.'</td></tr>
<tr class="memdesc:ga4eda0c1bfded5df89351b8ce8b9c2805"><td class="mdescLeft">&#160;</td><td class="mdescRight">Character used as a filling for right-align the right part of messages with "{hfill}". <br /></td></tr>
<tr class="memitem:ga4eda0c1bfded5df89351b8ce8b9c2805"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___default_config.html#ga4eda0c1bfded5df89351b8ce8b9c2805">CLUTCHLOG_DEFAULT_HFILL_MARK</a>&#160;&#160;&#160;'.'</td></tr>
<tr class="memdesc:ga4eda0c1bfded5df89351b8ce8b9c2805"><td class="mdescLeft">&#160;</td><td class="mdescRight">Character used as a filling for right-align the right part of messages with "{hfill}". <a href="group___default_config.html#ga4eda0c1bfded5df89351b8ce8b9c2805">More...</a><br /></td></tr>
<tr class="separator:ga4eda0c1bfded5df89351b8ce8b9c2805"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga8564be479b948ee3052b61783c66d415" name="ga8564be479b948ee3052b61783c66d415"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8564be479b948ee3052b61783c66d415">&#9670;&nbsp;</a></span>CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG&#160;&#160;&#160;clutchlog::level::progress</td>
</tr>
</table>
</div><div class="memdoc">
<p>Default level over which calls to the logger are optimized out when NDEBUG is defined. </p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00068">68</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
<a id="ga524c16f280d92ee8ab683162c9ce01fa" name="ga524c16f280d92ee8ab683162c9ce01fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga524c16f280d92ee8ab683162c9ce01fa">&#9670;&nbsp;</a></span>CLUTCHLOG_DEFAULT_FORMAT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CLUTCHLOG_DEFAULT_FORMAT&#160;&#160;&#160;&quot;{level_letter} {msg}\t\t\t\t\t{func} @ {file}:{line}\n&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p >Compile-time default format of the messages (debug mode: with absolute location). </p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00209">209</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
<a id="ga27b613c6727857a7cbcd0165d862034e" name="ga27b613c6727857a7cbcd0165d862034e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga27b613c6727857a7cbcd0165d862034e">&#9670;&nbsp;</a></span>CLUTCHDUMP_DEFAULT_FORMAT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CLUTCHDUMP_DEFAULT_FORMAT&#160;&#160;&#160;&quot;# {level} in {func} @ {file}:{line}&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compile-time default format of the comment line in file dump. </p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00232">232</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
<a id="ga54d29e956575e1c731eab5406135c5df" name="ga54d29e956575e1c731eab5406135c5df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga54d29e956575e1c731eab5406135c5df">&#9670;&nbsp;</a></span>CLUTCHDUMP_DEFAULT_SEP</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CLUTCHDUMP_DEFAULT_SEP&#160;&#160;&#160;&quot;\n&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compile-time default item separator for dump. </p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00250">250</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
<a id="ga45c4c964fad4ad1641d5c9c28c4645b9" name="ga45c4c964fad4ad1641d5c9c28c4645b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga45c4c964fad4ad1641d5c9c28c4645b9">&#9670;&nbsp;</a></span>CLUTCHLOG_DEFAULT_DEPTH_MARK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CLUTCHLOG_DEFAULT_DEPTH_MARK&#160;&#160;&#160;&quot;&gt;&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compile-time default mark for stack depth. </p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00257">257</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
<a id="ga98f30d814d4913a8a7c93a8793f49adf" name="ga98f30d814d4913a8a7c93a8793f49adf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga98f30d814d4913a8a7c93a8793f49adf">&#9670;&nbsp;</a></span>CLUTCHLOG_STRIP_CALLS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CLUTCHLOG_STRIP_CALLS&#160;&#160;&#160;5</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compile-time number of call stack levels to remove from depth display by default. </p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00264">264</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
<a id="ga4eda0c1bfded5df89351b8ce8b9c2805" name="ga4eda0c1bfded5df89351b8ce8b9c2805"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4eda0c1bfded5df89351b8ce8b9c2805">&#9670;&nbsp;</a></span>CLUTCHLOG_DEFAULT_HFILL_MARK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CLUTCHLOG_DEFAULT_HFILL_MARK&#160;&#160;&#160;'.'</td>
</tr>
</table>
</div><div class="memdoc">
<p>Character used as a filling for right-align the right part of messages with "{hfill}". </p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00271">271</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
</ul>
</div>
</body>