Skip to content

Commit

Permalink
update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@woodser
woodser committed Aug 6, 2022
1 parent ff965cb commit 2259306
Show file tree
Hide file tree
Showing 30 changed files with 3,005 additions and 437 deletions.
80 changes: 40 additions & 40 deletions docs/classmonero_1_1monero__wallet-members.html
View file

Large diffs are not rendered by default.

90 changes: 45 additions & 45 deletions docs/classmonero_1_1monero__wallet.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -287,8 +287,8 @@
<tr class="separator:a947b6826743e9707cbe831bc9207fafa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c89b2f74da444e254dcfd337ccb1034"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonero_1_1monero__wallet.html#a8c89b2f74da444e254dcfd337ccb1034">delete_address_book_entry</a> (uint64_t index)</td></tr>
<tr class="separator:a8c89b2f74da444e254dcfd337ccb1034"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8c3f8a5e987bee14bf8d540f3335ee0"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonero_1_1monero__wallet.html#ac8c3f8a5e987bee14bf8d540f3335ee0">create_payment_uri</a> (const <a class="el" href="structmonero_1_1monero__tx__config.html">monero_tx_config</a> &amp;config) const</td></tr>
<tr class="separator:ac8c3f8a5e987bee14bf8d540f3335ee0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a383c81b2b8ba566b39889be6088eefe0"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonero_1_1monero__wallet.html#a383c81b2b8ba566b39889be6088eefe0">get_payment_uri</a> (const <a class="el" href="structmonero_1_1monero__tx__config.html">monero_tx_config</a> &amp;config) const</td></tr>
<tr class="separator:a383c81b2b8ba566b39889be6088eefe0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc683a0719a7c8fe4aa80696e9d3eb5b"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr&lt; <a class="el" href="structmonero_1_1monero__tx__config.html">monero_tx_config</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonero_1_1monero__wallet.html#afc683a0719a7c8fe4aa80696e9d3eb5b">parse_payment_uri</a> (const std::string &amp;uri) const</td></tr>
<tr class="separator:afc683a0719a7c8fe4aa80696e9d3eb5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a341c6233de9dd4fb114badad6205c92f"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonero_1_1monero__wallet.html#a341c6233de9dd4fb114badad6205c92f">get_attribute</a> (const std::string &amp;key, std::string &amp;value) const</td></tr>
Expand All @@ -309,8 +309,8 @@
<tr class="separator:aa6e19b5d3eead2d07f2546f48c7cf11e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f9b31c8abcbb90caf1c4c00538dbf83"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonero_1_1monero__wallet.html#a8f9b31c8abcbb90caf1c4c00538dbf83">prepare_multisig</a> ()</td></tr>
<tr class="separator:a8f9b31c8abcbb90caf1c4c00538dbf83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98d17406e8da363e0bab6c155aa87267"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structmonero_1_1monero__multisig__init__result.html">monero_multisig_init_result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonero_1_1monero__wallet.html#a98d17406e8da363e0bab6c155aa87267">make_multisig</a> (const std::vector&lt; std::string &gt; &amp;multisig_hexes, int threshold, const std::string &amp;password)</td></tr>
<tr class="separator:a98d17406e8da363e0bab6c155aa87267"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04d5bd95d2c595a103186cb116c6bbd3"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonero_1_1monero__wallet.html#a04d5bd95d2c595a103186cb116c6bbd3">make_multisig</a> (const std::vector&lt; std::string &gt; &amp;multisig_hexes, int threshold, const std::string &amp;password)</td></tr>
<tr class="separator:a04d5bd95d2c595a103186cb116c6bbd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4beda75204b90456861a546068a8f674"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structmonero_1_1monero__multisig__init__result.html">monero_multisig_init_result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonero_1_1monero__wallet.html#a4beda75204b90456861a546068a8f674">exchange_multisig_keys</a> (const std::vector&lt; std::string &gt; &amp;mutisig_hexes, const std::string &amp;password)</td></tr>
<tr class="separator:a4beda75204b90456861a546068a8f674"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad512fb648e9166d0f9ee910271fcdb55"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonero_1_1monero__wallet.html#ad512fb648e9166d0f9ee910271fcdb55">export_multisig_hex</a> ()</td></tr>
Expand Down Expand Up @@ -780,42 +780,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3b13de391246727d013e768f

<p>Reimplemented in <a class="el" href="classmonero_1_1monero__wallet__full.html#ac6ef9acc3d1febf8a092eda28dbaccc6">monero::monero_wallet_full</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string monero::monero_wallet::create_payment_uri </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmonero_1_1monero__tx__config.html">monero_tx_config</a> &amp;&#160;</td>
<td class="paramname"><em>config</em></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>Creates a payment URI from a tx configuration.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>specifies configuration for a potential tx </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>is the payment uri </dd></dl>

<p>Reimplemented in <a class="el" href="classmonero_1_1monero__wallet__full.html#a0c6cc34dca4156481e4906843ae3c593">monero::monero_wallet_full</a>.</p>

</div>
</div>
<a id="ac1500500b3fcbd60b6c8bd9384a6c09e"></a>
Expand Down Expand Up @@ -2230,6 +2194,42 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8554771610e805aa18e023fc

<p>Reimplemented in <a class="el" href="classmonero_1_1monero__wallet__full.html#a1856b86e596e9a45c8d1c5f2af6549fc">monero::monero_wallet_full</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string monero::monero_wallet::get_payment_uri </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmonero_1_1monero__tx__config.html">monero_tx_config</a> &amp;&#160;</td>
<td class="paramname"><em>config</em></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>Creates a payment URI from a tx configuration.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>specifies configuration for a potential tx </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>is the payment uri </dd></dl>

<p>Reimplemented in <a class="el" href="classmonero_1_1monero__wallet__full.html#a7459e53acaed895df8de27b5e5aa0ff4">monero::monero_wallet_full</a>.</p>

</div>
</div>
<a id="a9136cf9c9ea362bf5b90b89d4377239b"></a>
Expand Down Expand Up @@ -3467,8 +3467,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a93fa8c7bce2de04a77161837

</div>
</div>
<a id="a98d17406e8da363e0bab6c155aa87267"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98d17406e8da363e0bab6c155aa87267">&#9670;&nbsp;</a></span>make_multisig()</h2>
<a id="a04d5bd95d2c595a103186cb116c6bbd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04d5bd95d2c595a103186cb116c6bbd3">&#9670;&nbsp;</a></span>make_multisig()</h2>

<div class="memitem">
<div class="memproto">
Expand All @@ -3477,7 +3477,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a98d17406e8da363e0bab6c15
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structmonero_1_1monero__multisig__init__result.html">monero_multisig_init_result</a> monero::monero_wallet::make_multisig </td>
<td class="memname">virtual std::string monero::monero_wallet::make_multisig </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>multisig_hexes</em>, </td>
Expand Down Expand Up @@ -3514,9 +3514,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#a98d17406e8da363e0bab6c15
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the result which has the multisig's address xor this wallet's multisig hex to share with participants iff not N/N </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>this wallet's multisig hex to share with participants </dd></dl>

<p>Reimplemented in <a class="el" href="classmonero_1_1monero__wallet__full.html#ab3bd9f79ad125bd5060dabf61faa2d98">monero::monero_wallet_full</a>.</p>
<p>Reimplemented in <a class="el" href="classmonero_1_1monero__wallet__full.html#ac28b11afbadc722da14b46302a061c03">monero::monero_wallet_full</a>.</p>

</div>
</div>
Expand Down
Loading

0 comments on commit 2259306

Please sign in to comment.