fix build script to handle documentation correctly
- make doc target was disabled by default. - update documentation.
This commit is contained in:
parent
978d3d9b66
commit
ad8fc14cf5
16 changed files with 177 additions and 76 deletions
|
|
@ -78,6 +78,9 @@ Macros</h2></td></tr>
|
|||
<tr class="memitem:ga572e3aa19d8b39e3ed0b9e91961104c2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga572e3aa19d8b39e3ed0b9e91961104c2">CLUTCHDUMP</a>(LEVEL, CONTAINER, FILENAME)</td></tr>
|
||||
<tr class="memdesc:ga572e3aa19d8b39e3ed0b9e91961104c2"><td class="mdescLeft"> </td><td class="mdescRight">Dump the given container. <a href="#ga572e3aa19d8b39e3ed0b9e91961104c2">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga572e3aa19d8b39e3ed0b9e91961104c2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga9f77cee4f853e582262930c9c17f90ae"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__UseMacros.html#ga9f77cee4f853e582262930c9c17f90ae">CLUTCHFUNC</a>(LEVEL, FUNC, ...)</td></tr>
|
||||
<tr class="memdesc:ga9f77cee4f853e582262930c9c17f90ae"><td class="mdescLeft"> </td><td class="mdescRight">Call an assert at the given level. <a href="#ga9f77cee4f853e582262930c9c17f90ae">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga9f77cee4f853e582262930c9c17f90ae"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<h2 class="groupheader">Macro Definition Documentation</h2>
|
||||
|
|
@ -112,12 +115,50 @@ Macros</h2></td></tr>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line">{ \</div><div class="line"> auto& logger = <a class="code" href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a>(); \</div><div class="line"> logger.dump(clutchlog::level::LEVEL, std::begin(CONTAINER), std::end(CONTAINER), \</div><div class="line"> <a class="code" href="group__UseMacros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>, FILENAME, <a class="code" href="group__DefaultConfigMacros.html#ga54d29e956575e1c731eab5406135c5df">CLUTCHDUMP_DEFAULT_SEP</a>); \</div><div class="line">}</div><div class="ttc" id="group__UseMacros_html_gae8911119d726a43b77f5781cb5a72813"><div class="ttname"><a href="group__UseMacros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a></div><div class="ttdeci">#define CLUTCHLOC</div><div class="ttdoc">Handy shortcuts to location. </div><div class="ttdef"><b>Definition:</b> clutchlog.h:81</div></div>
|
||||
<div class="ttc" id="classclutchlog_html_acfaceb77da01503b432644a3efaee4fa"><div class="ttname"><a href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a></div><div class="ttdeci">static clutchlog & logger()</div><div class="ttdoc">Get the logger instance. </div><div class="ttdef"><b>Definition:</b> clutchlog.h:149</div></div>
|
||||
<b>Value:</b><div class="fragment"><div class="line">{ \</div><div class="line"> auto& logger = <a class="code" href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a>(); \</div><div class="line"> logger.dump(clutchlog::level::LEVEL, std::begin(CONTAINER), std::end(CONTAINER), \</div><div class="line"> <a class="code" href="group__UseMacros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>, FILENAME, <a class="code" href="group__DefaultConfigMacros.html#ga54d29e956575e1c731eab5406135c5df">CLUTCHDUMP_DEFAULT_SEP</a>); \</div><div class="line">}</div><div class="ttc" id="group__UseMacros_html_gae8911119d726a43b77f5781cb5a72813"><div class="ttname"><a href="group__UseMacros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a></div><div class="ttdeci">#define CLUTCHLOC</div><div class="ttdoc">Handy shortcuts to location. </div><div class="ttdef"><b>Definition:</b> clutchlog.h:83</div></div>
|
||||
<div class="ttc" id="classclutchlog_html_acfaceb77da01503b432644a3efaee4fa"><div class="ttname"><a href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a></div><div class="ttdeci">static clutchlog & logger()</div><div class="ttdoc">Get the logger instance. </div><div class="ttdef"><b>Definition:</b> clutchlog.h:165</div></div>
|
||||
<div class="ttc" id="group__DefaultConfigMacros_html_ga54d29e956575e1c731eab5406135c5df"><div class="ttname"><a href="group__DefaultConfigMacros.html#ga54d29e956575e1c731eab5406135c5df">CLUTCHDUMP_DEFAULT_SEP</a></div><div class="ttdeci">#define CLUTCHDUMP_DEFAULT_SEP</div><div class="ttdoc">Default item separator for dump. </div><div class="ttdef"><b>Definition:</b> clutchlog.h:64</div></div>
|
||||
</div><!-- fragment -->
|
||||
<p>Dump the given container. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ga9f77cee4f853e582262930c9c17f90ae"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ga9f77cee4f853e582262930c9c17f90ae">◆ </a></span>CLUTCHFUNC</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define CLUTCHFUNC</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"> </td>
|
||||
<td class="paramname">LEVEL, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"> </td>
|
||||
<td class="paramname">FUNC, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"> </td>
|
||||
<td class="paramname"><em>...</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line">{ \</div><div class="line"> auto& logger = <a class="code" href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a>(); \</div><div class="line"> clutchlog::scope_t scope = logger.locate(clutchlog::level::LEVEL, <a class="code" href="group__UseMacros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>); \</div><div class="line"> if(scope.matches) { \</div><div class="line"> FUNC(__VA_ARGS__); \</div><div class="line"> } \</div><div class="line">}</div><div class="ttc" id="group__UseMacros_html_gae8911119d726a43b77f5781cb5a72813"><div class="ttname"><a href="group__UseMacros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a></div><div class="ttdeci">#define CLUTCHLOC</div><div class="ttdoc">Handy shortcuts to location. </div><div class="ttdef"><b>Definition:</b> clutchlog.h:83</div></div>
|
||||
<div class="ttc" id="classclutchlog_html_acfaceb77da01503b432644a3efaee4fa"><div class="ttname"><a href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a></div><div class="ttdeci">static clutchlog & logger()</div><div class="ttdoc">Get the logger instance. </div><div class="ttdef"><b>Definition:</b> clutchlog.h:165</div></div>
|
||||
</div><!-- fragment -->
|
||||
<p>Call an assert at the given level. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ga6f86187e2b35e7e1907d688f504a197d"></a>
|
||||
|
|
@ -145,8 +186,8 @@ Macros</h2></td></tr>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line">{ \</div><div class="line"> auto& logger = <a class="code" href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a>(); \</div><div class="line"> std::ostringstream msg ; msg << WHAT; \</div><div class="line"> logger.log(clutchlog::level::LEVEL, msg.str(), <a class="code" href="group__UseMacros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>); \</div><div class="line">}</div><div class="ttc" id="group__UseMacros_html_gae8911119d726a43b77f5781cb5a72813"><div class="ttname"><a href="group__UseMacros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a></div><div class="ttdeci">#define CLUTCHLOC</div><div class="ttdoc">Handy shortcuts to location. </div><div class="ttdef"><b>Definition:</b> clutchlog.h:81</div></div>
|
||||
<div class="ttc" id="classclutchlog_html_acfaceb77da01503b432644a3efaee4fa"><div class="ttname"><a href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a></div><div class="ttdeci">static clutchlog & logger()</div><div class="ttdoc">Get the logger instance. </div><div class="ttdef"><b>Definition:</b> clutchlog.h:149</div></div>
|
||||
<b>Value:</b><div class="fragment"><div class="line">{ \</div><div class="line"> auto& logger = <a class="code" href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a>(); \</div><div class="line"> std::ostringstream msg ; msg << WHAT; \</div><div class="line"> logger.log(clutchlog::level::LEVEL, msg.str(), <a class="code" href="group__UseMacros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a>); \</div><div class="line">}</div><div class="ttc" id="group__UseMacros_html_gae8911119d726a43b77f5781cb5a72813"><div class="ttname"><a href="group__UseMacros.html#gae8911119d726a43b77f5781cb5a72813">CLUTCHLOC</a></div><div class="ttdeci">#define CLUTCHLOC</div><div class="ttdoc">Handy shortcuts to location. </div><div class="ttdef"><b>Definition:</b> clutchlog.h:83</div></div>
|
||||
<div class="ttc" id="classclutchlog_html_acfaceb77da01503b432644a3efaee4fa"><div class="ttname"><a href="classclutchlog.html#acfaceb77da01503b432644a3efaee4fa">clutchlog::logger</a></div><div class="ttdeci">static clutchlog & logger()</div><div class="ttdoc">Get the logger instance. </div><div class="ttdef"><b>Definition:</b> clutchlog.h:165</div></div>
|
||||
</div><!-- fragment -->
|
||||
<p>Log a message at the given level. </p>
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue