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 2022-08-29 09:48:28 +02:00
commit 562f5682c6
53 changed files with 1111 additions and 916 deletions
Download patch file Download diff file Expand all files Collapse all files

57
docs/classclutchlog.html
View file

@ -168,27 +168,32 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grou
<tr class="separator:ga23dbb98f0d3c5cc21c232cde16cf317a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga63308e8deae3cfec6801318203494143"><td class="memTemplParams" colspan="2">
template&lt;class In &gt; </td></tr>
<tr class="memitem:ga63308e8deae3cfec6801318203494143"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga63308e8deae3cfec6801318203494143">dump</a> (const <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> &amp;stage, const In container_begin, const In container_end, const std::string &amp;<a class="el" href="group__UseMacros.html#ga10064493c22f5c03b502a42d814c5c5c">file</a>, const std::string &amp;<a class="el" href="group__UseMacros.html#gad32b5a0274dc03ee0004f67ba58b2447">func</a>, size_t <a class="el" href="group__UseMacros.html#gaa26c6b81ebaeb9e9daa3457e3a3d17c9">line</a>, const std::string &amp;filename_template=&quot;dump_{n}.dat&quot;, const std::string sep=dump_default_sep) const</td></tr>
<tr class="memitem:ga63308e8deae3cfec6801318203494143"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga63308e8deae3cfec6801318203494143">dump</a> (const <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> &amp;stage, const In container_begin, const In container_end, const std::string &amp;<a class="el" href="group__UseMacros.html#ga10064493c22f5c03b502a42d814c5c5c">file</a>, const std::string &amp;<a class="el" href="group__UseMacros.html#gad32b5a0274dc03ee0004f67ba58b2447">func</a>, size_t <a class="el" href="group__UseMacros.html#gaa26c6b81ebaeb9e9daa3457e3a3d17c9">line</a>, const std::string &amp;filename_template=&quot;dump_{n}.dat&quot;, const std::string sep=<a class="el" href="group__UseMacros.html#gaf898bffe23b125245e338d7495c76d45">dump_default_sep</a>) const</td></tr>
<tr class="memdesc:ga63308e8deae3cfec6801318203494143"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dump a serializable container after a comment line with log information. <br /></td></tr>
<tr class="separator:ga63308e8deae3cfec6801318203494143"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:ga0c4ac57601e6f8d146fd5cc060968ecc"><td class="memItemLeft" align="right" valign="top">
static std::string&#160;</td><td class="memItemRight" valign="bottom"><b>default_format</b> = <a class="el" href="group__UseMacros.html#ga524c16f280d92ee8ab683162c9ce01fa">CLUTCHLOG_DEFAULT_FORMAT</a></td></tr>
static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga0c4ac57601e6f8d146fd5cc060968ecc">default_format</a> = <a class="el" href="group__UseMacros.html#ga524c16f280d92ee8ab683162c9ce01fa">CLUTCHLOG_DEFAULT_FORMAT</a></td></tr>
<tr class="memdesc:ga0c4ac57601e6f8d146fd5cc060968ecc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default format of the messages. <br /></td></tr>
<tr class="separator:ga0c4ac57601e6f8d146fd5cc060968ecc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gace879554298e6e6e36dafef330c27be8"><td class="memItemLeft" align="right" valign="top">
static std::string&#160;</td><td class="memItemRight" valign="bottom"><b>dump_default_format</b> = <a class="el" href="group__UseMacros.html#ga27b613c6727857a7cbcd0165d862034e">CLUTCHDUMP_DEFAULT_FORMAT</a></td></tr>
static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gace879554298e6e6e36dafef330c27be8">dump_default_format</a> = <a class="el" href="group__UseMacros.html#ga27b613c6727857a7cbcd0165d862034e">CLUTCHDUMP_DEFAULT_FORMAT</a></td></tr>
<tr class="memdesc:gace879554298e6e6e36dafef330c27be8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default format of the comment line in file dump. <br /></td></tr>
<tr class="separator:gace879554298e6e6e36dafef330c27be8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf898bffe23b125245e338d7495c76d45"><td class="memItemLeft" align="right" valign="top">
static std::string&#160;</td><td class="memItemRight" valign="bottom"><b>dump_default_sep</b> = <a class="el" href="group__UseMacros.html#ga54d29e956575e1c731eab5406135c5df">CLUTCHDUMP_DEFAULT_SEP</a></td></tr>
static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gaf898bffe23b125245e338d7495c76d45">dump_default_sep</a> = <a class="el" href="group__UseMacros.html#ga54d29e956575e1c731eab5406135c5df">CLUTCHDUMP_DEFAULT_SEP</a></td></tr>
<tr class="memdesc:gaf898bffe23b125245e338d7495c76d45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default item separator for dump. <br /></td></tr>
<tr class="separator:gaf898bffe23b125245e338d7495c76d45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga229fd61519f1245282440120f2d45fb5"><td class="memItemLeft" align="right" valign="top">
static std::string&#160;</td><td class="memItemRight" valign="bottom"><b>default_depth_mark</b> = <a class="el" href="group__UseMacros.html#ga45c4c964fad4ad1641d5c9c28c4645b9">CLUTCHLOG_DEFAULT_DEPTH_MARK</a></td></tr>
static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga229fd61519f1245282440120f2d45fb5">default_depth_mark</a> = <a class="el" href="group__UseMacros.html#ga45c4c964fad4ad1641d5c9c28c4645b9">CLUTCHLOG_DEFAULT_DEPTH_MARK</a></td></tr>
<tr class="memdesc:ga229fd61519f1245282440120f2d45fb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default mark for stack depth. <br /></td></tr>
<tr class="separator:ga229fd61519f1245282440120f2d45fb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab2002468decc641989cc728f0a4dd4fe"><td class="memItemLeft" align="right" valign="top">
static unsigned int&#160;</td><td class="memItemRight" valign="bottom"><b>strip_calls</b> = <a class="el" href="group__UseMacros.html#ga98f30d814d4913a8a7c93a8793f49adf">CLUTCHLOG_STRIP_CALLS</a></td></tr>
<tr class="separator:gab2002468decc641989cc728f0a4dd4fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1a8cb6411726133208f5a2f2cb42d468"><td class="memItemLeft" align="right" valign="top">
static unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga1a8cb6411726133208f5a2f2cb42d468">default_strip_calls</a> = <a class="el" href="group__UseMacros.html#ga98f30d814d4913a8a7c93a8793f49adf">CLUTCHLOG_STRIP_CALLS</a></td></tr>
<tr class="memdesc:ga1a8cb6411726133208f5a2f2cb42d468"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of call stack levels to remove from depth display by default. <br /></td></tr>
<tr class="separator:ga1a8cb6411726133208f5a2f2cb42d468"><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>
High-level API</h2></td></tr>
@ -212,41 +217,49 @@ High-level API</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Internal details</h2></td></tr>
<tr class="memitem:gad6a8aef8df1de520a42ee68ee756fbf3"><td class="memItemLeft" align="right" valign="top">
static const size_t&#160;</td><td class="memItemRight" valign="bottom"><b>max_buffer</b> = 4096</td></tr>
<tr class="separator:gad6a8aef8df1de520a42ee68ee756fbf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga56ed762c056c5b1d0020863b11bd188e"><td class="memItemLeft" align="right" valign="top">
const size_t&#160;</td><td class="memItemRight" valign="bottom"><b>_strip_calls</b></td></tr>
const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga56ed762c056c5b1d0020863b11bd188e">_strip_calls</a></td></tr>
<tr class="memdesc:ga56ed762c056c5b1d0020863b11bd188e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current number of call stack levels to remove from depth display. <br /></td></tr>
<tr class="separator:ga56ed762c056c5b1d0020863b11bd188e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab1c377a376e6772fe1746ff7147c125f"><td class="memItemLeft" align="right" valign="top">
const std::map&lt; <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a>, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>_level_word</b></td></tr>
const std::map&lt; <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a>, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gab1c377a376e6772fe1746ff7147c125f">_level_word</a></td></tr>
<tr class="memdesc:gab1c377a376e6772fe1746ff7147c125f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dictionary of level identifier to their string representation. <br /></td></tr>
<tr class="separator:gab1c377a376e6772fe1746ff7147c125f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabd4625bf211bfbaa30d9c126fa3d7888"><td class="memItemLeft" align="right" valign="top">
std::map&lt; std::string, <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>_word_level</b></td></tr>
std::map&lt; std::string, <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gabd4625bf211bfbaa30d9c126fa3d7888">_word_level</a></td></tr>
<tr class="memdesc:gabd4625bf211bfbaa30d9c126fa3d7888"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dictionary of level string to their identifier. <br /></td></tr>
<tr class="separator:gabd4625bf211bfbaa30d9c126fa3d7888"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab805ac5c33885459f9f752518a4aa735"><td class="memItemLeft" align="right" valign="top">
std::map&lt; <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a>, <a class="el" href="classclutchlog_1_1fmt.html">fmt</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>_level_fmt</b></td></tr>
std::map&lt; <a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a>, <a class="el" href="classclutchlog_1_1fmt.html">fmt</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gab805ac5c33885459f9f752518a4aa735">_level_fmt</a></td></tr>
<tr class="memdesc:gab805ac5c33885459f9f752518a4aa735"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dictionary of level identifier to their format. <br /></td></tr>
<tr class="separator:gab805ac5c33885459f9f752518a4aa735"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7c6e3fc082bc6f55d50131ed2b32e81e"><td class="memItemLeft" align="right" valign="top">
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>_format_log</b></td></tr>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga7c6e3fc082bc6f55d50131ed2b32e81e">_format_log</a></td></tr>
<tr class="memdesc:ga7c6e3fc082bc6f55d50131ed2b32e81e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current format of the standard output. <br /></td></tr>
<tr class="separator:ga7c6e3fc082bc6f55d50131ed2b32e81e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5f4ddb57ce42e8be86a7c7d269f7bae5"><td class="memItemLeft" align="right" valign="top">
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>_format_dump</b></td></tr>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga5f4ddb57ce42e8be86a7c7d269f7bae5">_format_dump</a></td></tr>
<tr class="memdesc:ga5f4ddb57ce42e8be86a7c7d269f7bae5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current format of the file output. <br /></td></tr>
<tr class="separator:ga5f4ddb57ce42e8be86a7c7d269f7bae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1896f6c4b8597e3e76ff93970bd85167"><td class="memItemLeft" align="right" valign="top">
std::ostream *&#160;</td><td class="memItemRight" valign="bottom"><b>_out</b></td></tr>
std::ostream *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga1896f6c4b8597e3e76ff93970bd85167">_out</a></td></tr>
<tr class="memdesc:ga1896f6c4b8597e3e76ff93970bd85167"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard output. <br /></td></tr>
<tr class="separator:ga1896f6c4b8597e3e76ff93970bd85167"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeb60684c89bcef5aa9273075c21cc993"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a>&#160;</td><td class="memItemRight" valign="bottom"><b>_stage</b></td></tr>
<a class="el" href="group__UseMacros.html#ga10fd25a1b51c8c95bd6d876ce1b4b928">level</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gaeb60684c89bcef5aa9273075c21cc993">_stage</a></td></tr>
<tr class="memdesc:gaeb60684c89bcef5aa9273075c21cc993"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current log level. <br /></td></tr>
<tr class="separator:gaeb60684c89bcef5aa9273075c21cc993"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaded03528f34d9000f618419c482c5042"><td class="memItemLeft" align="right" valign="top">
std::regex&#160;</td><td class="memItemRight" valign="bottom"><b>_in_file</b></td></tr>
std::regex&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#gaded03528f34d9000f618419c482c5042">_in_file</a></td></tr>
<tr class="memdesc:gaded03528f34d9000f618419c482c5042"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current file location filter. <br /></td></tr>
<tr class="separator:gaded03528f34d9000f618419c482c5042"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga130c4f12eacbd2028102838fe16b734e"><td class="memItemLeft" align="right" valign="top">
std::regex&#160;</td><td class="memItemRight" valign="bottom"><b>_in_func</b></td></tr>
std::regex&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga130c4f12eacbd2028102838fe16b734e">_in_func</a></td></tr>
<tr class="memdesc:ga130c4f12eacbd2028102838fe16b734e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current function location filter. <br /></td></tr>
<tr class="separator:ga130c4f12eacbd2028102838fe16b734e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga41757198b29862832a14472a9e5e24c6"><td class="memItemLeft" align="right" valign="top">
std::regex&#160;</td><td class="memItemRight" valign="bottom"><b>_in_line</b></td></tr>
std::regex&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga41757198b29862832a14472a9e5e24c6">_in_line</a></td></tr>
<tr class="memdesc:ga41757198b29862832a14472a9e5e24c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current line location filter. <br /></td></tr>
<tr class="separator:ga41757198b29862832a14472a9e5e24c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0906d74275cedcd403da94879764815e"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><b>clutchlog</b> (<a class="el" href="classclutchlog.html">clutchlog</a> const &amp;)=delete</td></tr>