Skip to content

Commit ec6abd8

Browse files
authored
docs: update doxygen docs (woodser#128)
1 parent ba20afb commit ec6abd8

63 files changed

Lines changed: 3528 additions & 2420 deletions

File tree

Some content is hidden

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

docs/doxygen/annotated.html

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

docs/doxygen/classes.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/doxygen/classmonero_1_1monero__daemon-members.html

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

docs/doxygen/classmonero_1_1monero__daemon.html

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,8 @@
234234
<tr class="separator:ae312bd24390bd1a5bec659b9f0b1e17d"><td class="memSeparator" colspan="2">&#160;</td></tr>
235235
<tr class="memitem:a95ce62e3db68f088c130acfbd69a25a4" id="r_a95ce62e3db68f088c130acfbd69a25a4"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr&lt; <a class="el" href="structmonero_1_1monero__mining__status.html">monero_mining_status</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a95ce62e3db68f088c130acfbd69a25a4">get_mining_status</a> ()</td></tr>
236236
<tr class="separator:a95ce62e3db68f088c130acfbd69a25a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
237+
<tr class="memitem:a40dd65c931ebdcb04cb4b628b5c1ecd5" id="r_a40dd65c931ebdcb04cb4b628b5c1ecd5"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr&lt; <a class="el" href="structmonero_1_1monero__generate__blocks__result.html">monero_generate_blocks_result</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a40dd65c931ebdcb04cb4b628b5c1ecd5">generate_blocks</a> (const std::string &amp;wallet_address, uint64_t num_blocks, const boost::optional&lt; std::string &gt; &amp;prev_block_hash=boost::none, const boost::optional&lt; uint32_t &gt; &amp;starting_nonce=boost::none)</td></tr>
238+
<tr class="separator:a40dd65c931ebdcb04cb4b628b5c1ecd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
237239
<tr class="memitem:ab78760ef2e8ecc0cfd6c981116328da3" id="r_ab78760ef2e8ecc0cfd6c981116328da3"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab78760ef2e8ecc0cfd6c981116328da3">submit_block</a> (const std::string &amp;block_blob)</td></tr>
238240
<tr class="separator:ab78760ef2e8ecc0cfd6c981116328da3"><td class="memSeparator" colspan="2">&#160;</td></tr>
239241
<tr class="memitem:a2ad4f35d4989fa36a35ee4bb31cb72f3" id="r_a2ad4f35d4989fa36a35ee4bb31cb72f3"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2ad4f35d4989fa36a35ee4bb31cb72f3">submit_blocks</a> (const std::vector&lt; std::string &gt; &amp;block_blobs)</td></tr>
@@ -471,6 +473,58 @@ <h2 class="memtitle"><span class="permalink"><a href="#aacf854685ad321b497af8abe
471473

472474
<p>Reimplemented in <a class="el" href="classmonero_1_1monero__daemon__rpc.html#ac21c107e7cbc76ca29757f3129014ec7">monero::monero_daemon_rpc</a>.</p>
473475

476+
</div>
477+
</div>
478+
<a id="a40dd65c931ebdcb04cb4b628b5c1ecd5" name="a40dd65c931ebdcb04cb4b628b5c1ecd5"></a>
479+
<h2 class="memtitle"><span class="permalink"><a href="#a40dd65c931ebdcb04cb4b628b5c1ecd5">&#9670;&#160;</a></span>generate_blocks()</h2>
480+
481+
<div class="memitem">
482+
<div class="memproto">
483+
<table class="mlabels">
484+
<tr>
485+
<td class="mlabels-left">
486+
<table class="memname">
487+
<tr>
488+
<td class="memname">virtual std::shared_ptr&lt; <a class="el" href="structmonero_1_1monero__generate__blocks__result.html">monero_generate_blocks_result</a> &gt; monero::monero_daemon::generate_blocks </td>
489+
<td>(</td>
490+
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>wallet_address</em></span>, </td>
491+
</tr>
492+
<tr>
493+
<td class="paramkey"></td>
494+
<td></td>
495+
<td class="paramtype">uint64_t</td> <td class="paramname"><span class="paramname"><em>num_blocks</em></span>, </td>
496+
</tr>
497+
<tr>
498+
<td class="paramkey"></td>
499+
<td></td>
500+
<td class="paramtype">const boost::optional&lt; std::string &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>prev_block_hash</em></span><span class="paramdefsep"> = </span><span class="paramdefval">boost::none</span>, </td>
501+
</tr>
502+
<tr>
503+
<td class="paramkey"></td>
504+
<td></td>
505+
<td class="paramtype">const boost::optional&lt; uint32_t &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>starting_nonce</em></span><span class="paramdefsep"> = </span><span class="paramdefval">boost::none</span>&#160;)</td>
506+
</tr>
507+
</table>
508+
</td>
509+
<td class="mlabels-right">
510+
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel virtual">virtual</span></span> </td>
511+
</tr>
512+
</table>
513+
</div><div class="memdoc">
514+
<p>Generate blocks to a wallet address (regtest only).</p>
515+
<dl class="params"><dt>Parameters</dt><dd>
516+
<table class="params">
517+
<tr><td class="paramname">wallet_address</td><td>is the address of the wallet to receive miner transactions if block is successfully mined </td></tr>
518+
<tr><td class="paramname">num_blocks</td><td>is the number of blocks to generate </td></tr>
519+
<tr><td class="paramname">prev_block_hash</td><td>is the hash of the previous block to build on top of (optional, builds on the current tip if not given) </td></tr>
520+
<tr><td class="paramname">starting_nonce</td><td>is the starting nonce to use (optional) </td></tr>
521+
</table>
522+
</dd>
523+
</dl>
524+
<dl class="section return"><dt>Returns</dt><dd>the result of generating blocks; height is the height of the last block generated </dd></dl>
525+
526+
<p>Reimplemented in <a class="el" href="classmonero_1_1monero__daemon__rpc.html#a742b6dc19d8ead1f746fa95d6a9c2043">monero::monero_daemon_rpc</a>.</p>
527+
474528
</div>
475529
</div>
476530
<a id="a301d50fe37f6957c5625ee1364a4f8d3" name="a301d50fe37f6957c5625ee1364a4f8d3"></a>

0 commit comments

Comments
 (0)