comments for ui/view.h

This commit is contained in:
Tristan Krause 2019-07-31 11:59:24 +02:00
parent 9640bb00c8
commit 3b71364edf
112 changed files with 1746 additions and 437 deletions

View file

@ -83,33 +83,171 @@ $(function() {
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6dcc078e6bfb7d87b53a5aef758cfe5f"><td class="memItemLeft" align="right" valign="top"><a id="a6dcc078e6bfb7d87b53a5aef758cfe5f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DriverException</b> (const char *message)</td></tr>
<tr class="memitem:a6dcc078e6bfb7d87b53a5aef758cfe5f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDriverException.html#a6dcc078e6bfb7d87b53a5aef758cfe5f">DriverException</a> (const char *message)</td></tr>
<tr class="separator:a6dcc078e6bfb7d87b53a5aef758cfe5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf7f902d3fbbfcdbde8e54a058948519"><td class="memItemLeft" align="right" valign="top"><a id="abf7f902d3fbbfcdbde8e54a058948519"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DriverException</b> (const std::string &amp;message)</td></tr>
<tr class="memitem:abf7f902d3fbbfcdbde8e54a058948519"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDriverException.html#abf7f902d3fbbfcdbde8e54a058948519">DriverException</a> (const std::string &amp;message)</td></tr>
<tr class="separator:abf7f902d3fbbfcdbde8e54a058948519"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a781362760bcd75b1bd5448629df58446"><td class="memItemLeft" align="right" valign="top"><a id="a781362760bcd75b1bd5448629df58446"></a>
virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><b>what</b> () const throw ()</td></tr>
<tr class="memitem:a4e62b528e9a6c1a776b1a08487fac340"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDriverException.html#a4e62b528e9a6c1a776b1a08487fac340">~DriverException</a> () throw ()</td></tr>
<tr class="separator:a4e62b528e9a6c1a776b1a08487fac340"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a781362760bcd75b1bd5448629df58446"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDriverException.html#a781362760bcd75b1bd5448629df58446">what</a> () const throw ()</td></tr>
<tr class="separator:a781362760bcd75b1bd5448629df58446"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ab8777afe3f5aed2e66f2b2fcb480a651"><td class="memItemLeft" align="right" valign="top"><a id="ab8777afe3f5aed2e66f2b2fcb480a651"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>msg_</b></td></tr>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDriverException.html#ab8777afe3f5aed2e66f2b2fcb480a651">msg_</a></td></tr>
<tr class="memdesc:ab8777afe3f5aed2e66f2b2fcb480a651"><td class="mdescLeft">&#160;</td><td class="mdescRight">failure description <br /></td></tr>
<tr class="separator:ab8777afe3f5aed2e66f2b2fcb480a651"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Exception driver problems, for instance incompatible firmware version. </p>
<p class="definition">Definition at line <a class="el" href="driverexception_8h_source.html#l00010">10</a> of file <a class="el" href="driverexception_8h_source.html">driverexception.h</a>.</p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6dcc078e6bfb7d87b53a5aef758cfe5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6dcc078e6bfb7d87b53a5aef758cfe5f">&#9670;&nbsp;</a></span>DriverException() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DriverException::DriverException </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>as c-string </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="driverexception_8h_source.html#l00017">17</a> of file <a class="el" href="driverexception_8h_source.html">driverexception.h</a>.</p>
</div>
</div>
<a id="abf7f902d3fbbfcdbde8e54a058948519"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf7f902d3fbbfcdbde8e54a058948519">&#9670;&nbsp;</a></span>DriverException() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DriverException::DriverException </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>as c++-string </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="driverexception_8h_source.html#l00025">25</a> of file <a class="el" href="driverexception_8h_source.html">driverexception.h</a>.</p>
</div>
</div>
<a id="a4e62b528e9a6c1a776b1a08487fac340"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e62b528e9a6c1a776b1a08487fac340">&#9670;&nbsp;</a></span>~DriverException()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual DriverException::~DriverException </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2"></td>
</tr>
<tr>
<td align="right"></td><td>)</td><td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Standard-destructor </p>
<p class="definition">Definition at line <a class="el" href="driverexception_8h_source.html#l00032">32</a> of file <a class="el" href="driverexception_8h_source.html">driverexception.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a781362760bcd75b1bd5448629df58446"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a781362760bcd75b1bd5448629df58446">&#9670;&nbsp;</a></span>what()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* DriverException::what </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2"></td>
</tr>
<tr>
<td align="right"></td><td>)</td><td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get failure description </p><dl class="section return"><dt>Returns</dt><dd>error message as c-string </dd></dl>
<p class="definition">Definition at line <a class="el" href="driverexception_8h_source.html#l00040">40</a> of file <a class="el" href="driverexception_8h_source.html">driverexception.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>drv/<a class="el" href="driverexception_8h_source.html">driverexception.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jul 31 2019 11:33:44 for B15F by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Wed Jul 31 2019 11:58:58 for B15F by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>