Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
woodser committed Aug 22, 2022
1 parent 7376b1b commit 7791b67
Show file tree
Hide file tree
Showing 219 changed files with 7,474 additions and 9,949 deletions.
24 changes: 12 additions & 12 deletions docs/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<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.8.20"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Monero C++ Library: Class List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Expand All @@ -19,8 +19,8 @@
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Monero C++ Library
</div>
</td>
Expand All @@ -29,21 +29,22 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<!-- Generated by Doxygen 1.9.4 -->
<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');
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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 */
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
Expand All @@ -61,8 +62,7 @@
</div>

<div class="header">
<div class="headertitle">
<div class="title">Class List</div> </div>
<div class="headertitle"><div class="title">Class List</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
Expand Down Expand Up @@ -111,7 +111,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
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.4
</small></address>
</body>
</html>
100 changes: 27 additions & 73 deletions docs/classes.html

Large diffs are not rendered by default.

195 changes: 98 additions & 97 deletions docs/classmonero_1_1monero__wallet-members.html

Large diffs are not rendered by default.

845 changes: 441 additions & 404 deletions docs/classmonero_1_1monero__wallet.html

Large diffs are not rendered by default.

195 changes: 98 additions & 97 deletions docs/classmonero_1_1monero__wallet__full-members.html

Large diffs are not rendered by default.

855 changes: 555 additions & 300 deletions docs/classmonero_1_1monero__wallet__full.html

Large diffs are not rendered by default.

197 changes: 99 additions & 98 deletions docs/classmonero_1_1monero__wallet__keys-members.html

Large diffs are not rendered by default.

278 changes: 158 additions & 120 deletions docs/classmonero_1_1monero__wallet__keys.html

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions docs/classmonero_1_1monero__wallet__listener-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<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.8.20"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Monero C++ Library: Member List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Expand All @@ -19,8 +19,8 @@
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Monero C++ Library
</div>
</td>
Expand All @@ -29,21 +29,22 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<!-- Generated by Doxygen 1.9.4 -->
<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');
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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 */
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
Expand All @@ -65,22 +66,21 @@
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">monero::monero_wallet_listener Member List</div> </div>
<div class="headertitle"><div class="title">monero::monero_wallet_listener Member List</div></div>
</div><!--header-->
<div class="contents">

<p>This is the complete list of members for <a class="el" href="classmonero_1_1monero__wallet__listener.html">monero::monero_wallet_listener</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classmonero_1_1monero__wallet__listener.html#a98c1ace6690b5cbb2a72de61275f83e0">on_balances_changed</a>(uint64_t new_balance, uint64_t new_unlocked_balance)</td><td class="entry"><a class="el" href="classmonero_1_1monero__wallet__listener.html">monero::monero_wallet_listener</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classmonero_1_1monero__wallet__listener.html#a0276dc5dbe62b7df42e3eab1b5967895">on_new_block</a>(uint64_t height)</td><td class="entry"><a class="el" href="classmonero_1_1monero__wallet__listener.html">monero::monero_wallet_listener</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classmonero_1_1monero__wallet__listener.html#a0276dc5dbe62b7df42e3eab1b5967895">on_new_block</a>(uint64_t height)</td><td class="entry"><a class="el" href="classmonero_1_1monero__wallet__listener.html">monero::monero_wallet_listener</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="classmonero_1_1monero__wallet__listener.html#a858412263ef3d02da6453334abacff18">on_output_received</a>(const monero_output_wallet &amp;output)</td><td class="entry"><a class="el" href="classmonero_1_1monero__wallet__listener.html">monero::monero_wallet_listener</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classmonero_1_1monero__wallet__listener.html#a3938fd913222b0f107d5b133d1afd439">on_output_spent</a>(const monero_output_wallet &amp;output)</td><td class="entry"><a class="el" href="classmonero_1_1monero__wallet__listener.html">monero::monero_wallet_listener</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classmonero_1_1monero__wallet__listener.html#a3938fd913222b0f107d5b133d1afd439">on_output_spent</a>(const monero_output_wallet &amp;output)</td><td class="entry"><a class="el" href="classmonero_1_1monero__wallet__listener.html">monero::monero_wallet_listener</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="classmonero_1_1monero__wallet__listener.html#ad118f758ea41c8957cc75b7356e5370e">on_sync_progress</a>(uint64_t height, uint64_t start_height, uint64_t end_height, double percent_done, const std::string &amp;message)</td><td class="entry"><a class="el" href="classmonero_1_1monero__wallet__listener.html">monero::monero_wallet_listener</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="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
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.4
</small></address>
</body>
</html>
48 changes: 24 additions & 24 deletions docs/classmonero_1_1monero__wallet__listener.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<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.8.20"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Monero C++ Library: monero::monero_wallet_listener Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Expand All @@ -19,8 +19,8 @@
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Monero C++ Library
</div>
</td>
Expand All @@ -29,21 +29,22 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<!-- Generated by Doxygen 1.9.4 -->
<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');
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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 */
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
Expand All @@ -68,14 +69,13 @@
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classmonero_1_1monero__wallet__listener-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">monero::monero_wallet_listener Class Reference</div> </div>
<div class="headertitle"><div class="title">monero::monero_wallet_listener Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="monero__wallet_8h_source.html">monero_wallet.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad118f758ea41c8957cc75b7356e5370e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonero_1_1monero__wallet__listener.html#ad118f758ea41c8957cc75b7356e5370e">on_sync_progress</a> (uint64_t height, uint64_t start_height, uint64_t end_height, double percent_done, const std::string &amp;message)</td></tr>
<tr class="separator:ad118f758ea41c8957cc75b7356e5370e"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand All @@ -89,9 +89,9 @@
<tr class="separator:a3938fd913222b0f107d5b133d1afd439"><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>Interface to receive wallet notifications. </p>
<div class="textblock"><p >Interface to receive wallet notifications. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a98c1ace6690b5cbb2a72de61275f83e0"></a>
<a id="a98c1ace6690b5cbb2a72de61275f83e0" name="a98c1ace6690b5cbb2a72de61275f83e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98c1ace6690b5cbb2a72de61275f83e0">&#9670;&nbsp;</a></span>on_balances_changed()</h2>

<div class="memitem">
Expand Down Expand Up @@ -124,7 +124,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a98c1ace6690b5cbb2a72de61
</tr>
</table>
</div><div class="memdoc">
<p>Invoked when the wallet's balances change.</p>
<p >Invoked when the wallet's balances change.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">new_balance</td><td>- new balance </td></tr>
Expand All @@ -135,7 +135,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a98c1ace6690b5cbb2a72de61

</div>
</div>
<a id="a0276dc5dbe62b7df42e3eab1b5967895"></a>
<a id="a0276dc5dbe62b7df42e3eab1b5967895" name="a0276dc5dbe62b7df42e3eab1b5967895"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0276dc5dbe62b7df42e3eab1b5967895">&#9670;&nbsp;</a></span>on_new_block()</h2>

<div class="memitem">
Expand All @@ -158,7 +158,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0276dc5dbe62b7df42e3eab1
</tr>
</table>
</div><div class="memdoc">
<p>Invoked when a new block is processed.</p>
<p >Invoked when a new block is processed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">block</td><td>- the newly processed block </td></tr>
Expand All @@ -168,7 +168,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0276dc5dbe62b7df42e3eab1

</div>
</div>
<a id="a858412263ef3d02da6453334abacff18"></a>
<a id="a858412263ef3d02da6453334abacff18" name="a858412263ef3d02da6453334abacff18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a858412263ef3d02da6453334abacff18">&#9670;&nbsp;</a></span>on_output_received()</h2>

<div class="memitem">
Expand All @@ -191,7 +191,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a858412263ef3d02da6453334
</tr>
</table>
</div><div class="memdoc">
<p>Invoked when the wallet receives an output.</p>
<p >Invoked when the wallet receives an output.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">output</td><td>- the received output </td></tr>
Expand All @@ -201,7 +201,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a858412263ef3d02da6453334

</div>
</div>
<a id="a3938fd913222b0f107d5b133d1afd439"></a>
<a id="a3938fd913222b0f107d5b133d1afd439" name="a3938fd913222b0f107d5b133d1afd439"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3938fd913222b0f107d5b133d1afd439">&#9670;&nbsp;</a></span>on_output_spent()</h2>

<div class="memitem">
Expand All @@ -224,7 +224,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3938fd913222b0f107d5b133
</tr>
</table>
</div><div class="memdoc">
<p>Invoked when the wallet spends an output.</p>
<p >Invoked when the wallet spends an output.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">output</td><td>- the spent output </td></tr>
Expand All @@ -234,7 +234,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3938fd913222b0f107d5b133

</div>
</div>
<a id="ad118f758ea41c8957cc75b7356e5370e"></a>
<a id="ad118f758ea41c8957cc75b7356e5370e" name="ad118f758ea41c8957cc75b7356e5370e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad118f758ea41c8957cc75b7356e5370e">&#9670;&nbsp;</a></span>on_sync_progress()</h2>

<div class="memitem">
Expand Down Expand Up @@ -285,7 +285,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad118f758ea41c8957cc75b73
</tr>
</table>
</div><div class="memdoc">
<p>Invoked when sync progress is made.</p>
<p >Invoked when sync progress is made.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">height</td><td>- height of the synced block </td></tr>
Expand All @@ -305,7 +305,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad118f758ea41c8957cc75b73
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
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.4
</small></address>
</body>
</html>
Loading

0 comments on commit 7791b67

Please sign in to comment.