Skip to content

Commit

Permalink
generate doxygen pages
Browse files Browse the repository at this point in the history
  • Loading branch information
paroj committed Sep 21, 2024
0 parents commit 690fdba
Show file tree
Hide file tree
Showing 785 changed files with 61,242 additions and 0 deletions.
118 changes: 118 additions & 0 deletions annotated.html

Large diffs are not rendered by default.

Binary file added bc_s.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added bdwn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
90 changes: 90 additions & 0 deletions classCaelum_1_1AccesorPropertyDescriptor-members.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Caelum: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Caelum
&#160;<span id="projectnumber">0.6.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.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 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCaelum.html">Caelum</a></li><li class="navelem"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html">AccesorPropertyDescriptor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt; Member List</div> </div>
</div><!--header-->
<div class="contents">

<p>This is the complete list of members for <a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html">Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>AccesorPropertyDescriptor</b>(GetFunc getFunc, SetFunc setFunc) (defined in <a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html">Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;</a>)</td><td class="entry"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html">Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html#a0edbebe83376345509a3a7b759af4b7a">canGetValue</a>() const</td><td class="entry"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html">Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html#a12933ef124e9a7539b31641580f9dcbc">canSetValue</a>() const</td><td class="entry"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html">Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>GetFunc</b> typedef (defined in <a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html">Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;</a>)</td><td class="entry"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html">Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html#a7ee70530f9d7f48dc29e464a41687b61">getValueTyped</a>(const void *target) const</td><td class="entry"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html">Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>SetFunc</b> typedef (defined in <a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html">Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;</a>)</td><td class="entry"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html">Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html#a6dc03135df95de739c6b6a674a394558">setValueTyped</a>(void *target, const ParamT &amp;value) const</td><td class="entry"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html">Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>~ValuePropertyDescriptor</b>() (defined in <a class="el" href="classCaelum_1_1ValuePropertyDescriptor.html">Caelum::ValuePropertyDescriptor</a>)</td><td class="entry"><a class="el" href="classCaelum_1_1ValuePropertyDescriptor.html">Caelum::ValuePropertyDescriptor</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
163 changes: 163 additions & 0 deletions classCaelum_1_1AccesorPropertyDescriptor.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Caelum: Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Caelum
&#160;<span id="projectnumber">0.6.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.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 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCaelum.html">Caelum</a></li><li class="navelem"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html">AccesorPropertyDescriptor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classCaelum_1_1AccesorPropertyDescriptor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classCaelum_1_1ValuePropertyDescriptor.html" title="Basic property descriptor interface.">ValuePropertyDescriptor</a> implementation based on function pointers to get/set methods.
<a href="classCaelum_1_1AccesorPropertyDescriptor.html#details">More...</a></p>

<p><code>#include &lt;TypeDescriptor.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classCaelum_1_1AccesorPropertyDescriptor__inherit__graph.svg" width="264" height="231"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a7996bd4fe38eb764142b9b4e0402b9c5"><td class="memItemLeft" align="right" valign="top"><a id="a7996bd4fe38eb764142b9b4e0402b9c5"></a>
typedef void(TargetT::*&#160;</td><td class="memItemRight" valign="bottom"><b>SetFunc</b>) (InParamT)</td></tr>
<tr class="separator:a7996bd4fe38eb764142b9b4e0402b9c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa784a67e0b9624f01e6887b0853615a3"><td class="memItemLeft" align="right" valign="top"><a id="aa784a67e0b9624f01e6887b0853615a3"></a>
typedef OutParamT(TargetT::*&#160;</td><td class="memItemRight" valign="bottom"><b>GetFunc</b>) (void) const</td></tr>
<tr class="separator:aa784a67e0b9624f01e6887b0853615a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a75f11cf9c24f0783b6e947c806a36b16"><td class="memItemLeft" align="right" valign="top"><a id="a75f11cf9c24f0783b6e947c806a36b16"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>AccesorPropertyDescriptor</b> (GetFunc getFunc, SetFunc setFunc)</td></tr>
<tr class="separator:a75f11cf9c24f0783b6e947c806a36b16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0edbebe83376345509a3a7b759af4b7a"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html#a0edbebe83376345509a3a7b759af4b7a">canGetValue</a> () const</td></tr>
<tr class="memdesc:a0edbebe83376345509a3a7b759af4b7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the value of the property can be read (true means write-only). <a href="classCaelum_1_1AccesorPropertyDescriptor.html#a0edbebe83376345509a3a7b759af4b7a">More...</a><br /></td></tr>
<tr class="separator:a0edbebe83376345509a3a7b759af4b7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12933ef124e9a7539b31641580f9dcbc"><td class="memItemLeft" align="right" valign="top"><a id="a12933ef124e9a7539b31641580f9dcbc"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html#a12933ef124e9a7539b31641580f9dcbc">canSetValue</a> () const</td></tr>
<tr class="memdesc:a12933ef124e9a7539b31641580f9dcbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the value of the property can be set (false means read-only). <br /></td></tr>
<tr class="separator:a12933ef124e9a7539b31641580f9dcbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ee70530f9d7f48dc29e464a41687b61"><td class="memItemLeft" align="right" valign="top"><a id="a7ee70530f9d7f48dc29e464a41687b61"></a>
virtual const ParamT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html#a7ee70530f9d7f48dc29e464a41687b61">getValueTyped</a> (const void *target) const</td></tr>
<tr class="memdesc:a7ee70530f9d7f48dc29e464a41687b61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the property's value. <br /></td></tr>
<tr class="separator:a7ee70530f9d7f48dc29e464a41687b61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6dc03135df95de739c6b6a674a394558"><td class="memItemLeft" align="right" valign="top"><a id="a6dc03135df95de739c6b6a674a394558"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html#a6dc03135df95de739c6b6a674a394558">setValueTyped</a> (void *target, const ParamT &amp;value) const</td></tr>
<tr class="memdesc:a6dc03135df95de739c6b6a674a394558"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the property's value. <br /></td></tr>
<tr class="separator:a6dc03135df95de739c6b6a674a394558"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class TargetT, typename ParamT, typename InParamT = const ParamT&amp;, typename OutParamT = const ParamT&gt;<br />
class Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;</h3>

<p><a class="el" href="classCaelum_1_1ValuePropertyDescriptor.html" title="Basic property descriptor interface.">ValuePropertyDescriptor</a> implementation based on function pointers to get/set methods. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a0edbebe83376345509a3a7b759af4b7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0edbebe83376345509a3a7b759af4b7a">&#9670;&nbsp;</a></span>canGetValue()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TargetT , typename ParamT , typename InParamT = const ParamT&amp;, typename OutParamT = const ParamT&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="classCaelum_1_1AccesorPropertyDescriptor.html">Caelum::AccesorPropertyDescriptor</a>&lt; TargetT, ParamT, InParamT, OutParamT &gt;::canGetValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>If the value of the property can be read (true means write-only). </p>
<p>This is false for write-only properties. Write-only properties are generally a bad idea but they are supported. Scripting (with .os files) doesn't actually require reading existing values. </p>

<p>Implements <a class="el" href="classCaelum_1_1ValuePropertyDescriptor.html#ad24a340b597c8397d494d57da1439987">Caelum::ValuePropertyDescriptor</a>.</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
5 changes: 5 additions & 0 deletions classCaelum_1_1AccesorPropertyDescriptor__inherit__graph.map
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<map id="Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;" name="Caelum::AccesorPropertyDescriptor&lt; TargetT, ParamT, InParamT, OutParamT &gt;">
<area shape="rect" id="node1" title="ValuePropertyDescriptor implementation based on function pointers to get/set methods." alt="" coords="5,169,259,225"/>
<area shape="rect" id="node2" href="$classCaelum_1_1TypedValuePropertyDescriptor.html" title=" " alt="" coords="27,80,237,121"/>
<area shape="rect" id="node3" href="$classCaelum_1_1ValuePropertyDescriptor.html" title="Basic property descriptor interface." alt="" coords="13,5,251,32"/>
</map>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
4009264f8ba235292a9a964343ba1527
Loading

0 comments on commit 690fdba

Please sign in to comment.