Skip to content

Commit 068ae9a

Browse files
committed
Added some/none in make, mod. doc
1 parent d64d7b9 commit 068ae9a

File tree

367 files changed

+6322
-1600
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

367 files changed

+6322
-1600
lines changed

Doxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -791,7 +791,7 @@ WARN_LOGFILE =
791791
# Note: If this tag is empty the current directory is searched.
792792

793793
INPUT = include \
794-
README.md
794+
Doxymain.md
795795

796796
# This tag can be used to specify the character encoding of the source files
797797
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -983,7 +983,7 @@ FILTER_SOURCE_PATTERNS =
983983
# (index.html). This can be useful if you have a project on for instance GitHub
984984
# and want to reuse the introduction page also for the doxygen output.
985985

986-
USE_MDFILE_AS_MAINPAGE = README.md
986+
USE_MDFILE_AS_MAINPAGE = Doxymain.md
987987

988988
#---------------------------------------------------------------------------
989989
# Configuration options related to source browsing

Doxymain.md

Whitespace-only changes.

doc/html/_doxymain_8md_source.html

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Support Class Library: Doxymain.md Source File</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">Support Class Library
25+
</div>
26+
<div id="projectbrief">A set of tools providing classes and utility</div>
27+
</td>
28+
</tr>
29+
</tbody>
30+
</table>
31+
</div>
32+
<!-- end header part -->
33+
<!-- Generated by Doxygen 1.8.13 -->
34+
<script type="text/javascript">
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
36+
</script>
37+
<script type="text/javascript" src="menudata.js"></script>
38+
<script type="text/javascript" src="menu.js"></script>
39+
<script type="text/javascript">
40+
$(function() {
41+
initMenu('',true,false,'search.php','Search');
42+
$(document).ready(function() { init_search(); });
43+
});
44+
</script>
45+
<div id="main-nav"></div>
46+
</div><!-- top -->
47+
<!-- window showing the filter options -->
48+
<div id="MSearchSelectWindow"
49+
onmouseover="return searchBox.OnSearchSelectShow()"
50+
onmouseout="return searchBox.OnSearchSelectHide()"
51+
onkeydown="return searchBox.OnSearchSelectKey(event)">
52+
</div>
53+
54+
<!-- iframe showing the search results (closed by default) -->
55+
<div id="MSearchResultsWindow">
56+
<iframe src="javascript:void(0)" frameborder="0"
57+
name="MSearchResults" id="MSearchResults">
58+
</iframe>
59+
</div>
60+
61+
<div class="header">
62+
<div class="headertitle">
63+
<div class="title">Doxymain.md</div> </div>
64+
</div><!--header-->
65+
<div class="contents">
66+
<div class="fragment"></div><!-- fragment --></div><!-- contents -->
67+
<!-- start footer part -->
68+
<hr class="footer"/><address class="footer"><small>
69+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
70+
<img class="footer" src="doxygen.png" alt="doxygen"/>
71+
</a> 1.8.13
72+
</small></address>
73+
</body>
74+
</html>

doc/html/_either_8h_source.html

Lines changed: 33 additions & 29 deletions
Large diffs are not rendered by default.

doc/html/_end_stream_iterator_8h_source.html

Lines changed: 13 additions & 8 deletions
Large diffs are not rendered by default.

doc/html/_exception_8h_source.html

Lines changed: 3 additions & 2 deletions
Large diffs are not rendered by default.

doc/html/_runtime_exception_8h_source.html

Lines changed: 3 additions & 2 deletions
Large diffs are not rendered by default.

doc/html/_stream_8h_source.html

Lines changed: 6 additions & 4 deletions
Large diffs are not rendered by default.

doc/html/_stream_iterator_8h_source.html

Lines changed: 4 additions & 3 deletions
Large diffs are not rendered by default.

doc/html/annotated.html

Lines changed: 22 additions & 21 deletions
Large diffs are not rendered by default.

doc/html/classes.html

Lines changed: 14 additions & 14 deletions
Large diffs are not rendered by default.

doc/html/classscl_1_1exceptions_1_1_empty_optional_access-members.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,10 @@
7070

7171
<p>This is the complete list of members for <a class="el" href="classscl_1_1exceptions_1_1_empty_optional_access.html">scl::exceptions::EmptyOptionalAccess</a>, including all inherited members.</p>
7272
<table class="directory">
73-
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>_reason</b> (defined in <a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a>)</td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
73+
<tr class="even"><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#ac2f9253b6a551767e364a329872dcc5e">_reason</a></td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
7474
<tr><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_empty_optional_access.html#a94a0713af5005d8f6caa97f008f38d74">EmptyOptionalAccess</a>()</td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_empty_optional_access.html">scl::exceptions::EmptyOptionalAccess</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
7575
<tr class="even"><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#a8e4ada776e83cae6f03664226f7adf8f">Exception</a>(T &amp;&amp;reason)</td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
76-
<tr><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#ac0e6737c519a544b4eda254c08b64210">reason</a>() const override</td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
76+
<tr><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#a46e0aa363a5b2bc55956e38c5f1d1255">reason</a>() const override</td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
7777
<tr class="even"><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_empty_optional_access.html#a78e46a77e8a8c59a21ae10477ae2292b">type</a>() const noexcept override</td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_empty_optional_access.html">scl::exceptions::EmptyOptionalAccess</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
7878
<tr><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#a7dc95f30f32c66e6296c701649c81704">what</a>() const noexcept override</td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
7979
</table></div><!-- contents -->

doc/html/classscl_1_1exceptions_1_1_empty_optional_access.html

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -105,12 +105,12 @@
105105
<tr class="separator:a94a0713af5005d8f6caa97f008f38d74"><td class="memSeparator" colspan="2">&#160;</td></tr>
106106
<tr class="inherit_header pub_methods_classscl_1_1exceptions_1_1_exception"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classscl_1_1exceptions_1_1_exception')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td></tr>
107107
<tr class="memitem:a8e4ada776e83cae6f03664226f7adf8f inherit pub_methods_classscl_1_1exceptions_1_1_exception"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
108-
<tr class="memitem:a8e4ada776e83cae6f03664226f7adf8f inherit pub_methods_classscl_1_1exceptions_1_1_exception"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#a8e4ada776e83cae6f03664226f7adf8f">Exception</a> (T &amp;&amp;<a class="el" href="classscl_1_1exceptions_1_1_exception.html#ac0e6737c519a544b4eda254c08b64210">reason</a>)</td></tr>
108+
<tr class="memitem:a8e4ada776e83cae6f03664226f7adf8f inherit pub_methods_classscl_1_1exceptions_1_1_exception"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#a8e4ada776e83cae6f03664226f7adf8f">Exception</a> (T &amp;&amp;<a class="el" href="classscl_1_1exceptions_1_1_exception.html#a46e0aa363a5b2bc55956e38c5f1d1255">reason</a>)</td></tr>
109109
<tr class="memdesc:a8e4ada776e83cae6f03664226f7adf8f inherit pub_methods_classscl_1_1exceptions_1_1_exception"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an <a class="el" href="classscl_1_1exceptions_1_1_exception.html" title="Base class for all regular exceptions. ">scl::exceptions::Exception</a> from an error message. <a href="classscl_1_1exceptions_1_1_exception.html#a8e4ada776e83cae6f03664226f7adf8f">More...</a><br /></td></tr>
110110
<tr class="separator:a8e4ada776e83cae6f03664226f7adf8f inherit pub_methods_classscl_1_1exceptions_1_1_exception"><td class="memSeparator" colspan="2">&#160;</td></tr>
111-
<tr class="memitem:ac0e6737c519a544b4eda254c08b64210 inherit pub_methods_classscl_1_1exceptions_1_1_exception"><td class="memItemLeft" align="right" valign="top">const char *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#ac0e6737c519a544b4eda254c08b64210">reason</a> () const override</td></tr>
112-
<tr class="memdesc:ac0e6737c519a544b4eda254c08b64210 inherit pub_methods_classscl_1_1exceptions_1_1_exception"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the reason. <a href="classscl_1_1exceptions_1_1_exception.html#ac0e6737c519a544b4eda254c08b64210">More...</a><br /></td></tr>
113-
<tr class="separator:ac0e6737c519a544b4eda254c08b64210 inherit pub_methods_classscl_1_1exceptions_1_1_exception"><td class="memSeparator" colspan="2">&#160;</td></tr>
111+
<tr class="memitem:a46e0aa363a5b2bc55956e38c5f1d1255 inherit pub_methods_classscl_1_1exceptions_1_1_exception"><td class="memItemLeft" align="right" valign="top">const char *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#a46e0aa363a5b2bc55956e38c5f1d1255">reason</a> () const override</td></tr>
112+
<tr class="memdesc:a46e0aa363a5b2bc55956e38c5f1d1255 inherit pub_methods_classscl_1_1exceptions_1_1_exception"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the reason. <a href="classscl_1_1exceptions_1_1_exception.html#a46e0aa363a5b2bc55956e38c5f1d1255">More...</a><br /></td></tr>
113+
<tr class="separator:a46e0aa363a5b2bc55956e38c5f1d1255 inherit pub_methods_classscl_1_1exceptions_1_1_exception"><td class="memSeparator" colspan="2">&#160;</td></tr>
114114
<tr class="memitem:a7dc95f30f32c66e6296c701649c81704 inherit pub_methods_classscl_1_1exceptions_1_1_exception"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#a7dc95f30f32c66e6296c701649c81704">what</a> () const noexcept override</td></tr>
115115
<tr class="memdesc:a7dc95f30f32c66e6296c701649c81704 inherit pub_methods_classscl_1_1exceptions_1_1_exception"><td class="mdescLeft">&#160;</td><td class="mdescRight">Override that uses the user defined reason. <a href="classscl_1_1exceptions_1_1_exception.html#a7dc95f30f32c66e6296c701649c81704">More...</a><br /></td></tr>
116116
<tr class="separator:a7dc95f30f32c66e6296c701649c81704 inherit pub_methods_classscl_1_1exceptions_1_1_exception"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -121,9 +121,10 @@
121121
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
122122
Additional Inherited Members</h2></td></tr>
123123
<tr class="inherit_header pro_attribs_classscl_1_1exceptions_1_1_exception"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classscl_1_1exceptions_1_1_exception')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td></tr>
124-
<tr class="memitem:adf2b37f6b45ee8f270669f28a6bf6675 inherit pro_attribs_classscl_1_1exceptions_1_1_exception"><td class="memItemLeft" align="right" valign="top"><a id="adf2b37f6b45ee8f270669f28a6bf6675"></a>
125-
const char *const&#160;</td><td class="memItemRight" valign="bottom"><b>_reason</b> = &quot;&quot;</td></tr>
126-
<tr class="separator:adf2b37f6b45ee8f270669f28a6bf6675 inherit pro_attribs_classscl_1_1exceptions_1_1_exception"><td class="memSeparator" colspan="2">&#160;</td></tr>
124+
<tr class="memitem:ac2f9253b6a551767e364a329872dcc5e inherit pro_attribs_classscl_1_1exceptions_1_1_exception"><td class="memItemLeft" align="right" valign="top"><a id="ac2f9253b6a551767e364a329872dcc5e"></a>
125+
const char *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#ac2f9253b6a551767e364a329872dcc5e">_reason</a> = &quot;&quot;</td></tr>
126+
<tr class="memdesc:ac2f9253b6a551767e364a329872dcc5e inherit pro_attribs_classscl_1_1exceptions_1_1_exception"><td class="mdescLeft">&#160;</td><td class="mdescRight">The error message that comes with this <a class="el" href="classscl_1_1exceptions_1_1_exception.html" title="Base class for all regular exceptions. ">Exception</a>. <br /></td></tr>
127+
<tr class="separator:ac2f9253b6a551767e364a329872dcc5e inherit pro_attribs_classscl_1_1exceptions_1_1_exception"><td class="memSeparator" colspan="2">&#160;</td></tr>
127128
</table>
128129
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
129130
<div class="textblock"><p><a class="el" href="classscl_1_1exceptions_1_1_exception.html" title="Base class for all regular exceptions. ">Exception</a> class used when attempting to access the value of an empty <a class="el" href="classscl_1_1utils_1_1_optional.html" title="A class that allows the use of optional types (might be there) ">scl::utils::Optional</a>. </p>

doc/html/classscl_1_1exceptions_1_1_exception-members.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@
7070

7171
<p>This is the complete list of members for <a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a>, including all inherited members.</p>
7272
<table class="directory">
73-
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>_reason</b> (defined in <a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a>)</td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
73+
<tr class="even"><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#ac2f9253b6a551767e364a329872dcc5e">_reason</a></td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
7474
<tr><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#a8e4ada776e83cae6f03664226f7adf8f">Exception</a>(T &amp;&amp;reason)</td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
75-
<tr class="even"><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#ac0e6737c519a544b4eda254c08b64210">reason</a>() const override</td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
75+
<tr class="even"><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#a46e0aa363a5b2bc55956e38c5f1d1255">reason</a>() const override</td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
7676
<tr><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#a68d7d632f98acfb16c08bc738b7f1210">type</a>() const noexcept override</td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
7777
<tr class="even"><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html#a7dc95f30f32c66e6296c701649c81704">what</a>() const noexcept override</td><td class="entry"><a class="el" href="classscl_1_1exceptions_1_1_exception.html">scl::exceptions::Exception</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
7878
</table></div><!-- contents -->

0 commit comments

Comments
 (0)