joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 17:56:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add doxygen docs and link to them from main page

Browse source
This commit is contained in:
thephez 2017-12-14 15:34:41 -05:00
parent d327ad9771
commit f94fdd7239
5496 changed files with 984413 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

230
en/doxygen/html/key_8h.html Normal file
View file

@ -0,0 +1,230 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Dash Core: src/key.h File 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Dash Core
&#160;<span id="projectnumber">0.12.2.1</span>
</div>
<div id="projectbrief">P2P Digital Currency</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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-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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('key_8h.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">key.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="pubkey_8h_source.html">pubkey.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="serialize_8h_source.html">serialize.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="secure_8h_source.html">support/allocators/secure.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="uint256_8h_source.html">uint256.h</a>&quot;</code><br />
<code>#include &lt;stdexcept&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
</div>
<p><a href="key_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCKey.html">CKey</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structCExtKey.html">CExtKey</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a1da569b8b6e5b3fa1196cc1b877e7f54"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; unsigned char, <a class="el" href="structsecure__allocator.html">secure_allocator</a>&lt; unsigned char &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="key_8h.html#a1da569b8b6e5b3fa1196cc1b877e7f54">CPrivKey</a></td></tr>
<tr class="separator:a1da569b8b6e5b3fa1196cc1b877e7f54"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a5ee69136607b1012d64a045ee44ccae2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="key_8h.html#a5ee69136607b1012d64a045ee44ccae2">ECC_Start</a> (void)</td></tr>
<tr class="separator:a5ee69136607b1012d64a045ee44ccae2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fb68c634cf5491218253147eb4e04c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="key_8h.html#a8fb68c634cf5491218253147eb4e04c8">ECC_Stop</a> (void)</td></tr>
<tr class="separator:a8fb68c634cf5491218253147eb4e04c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55cc40f04bf887c1000667caccb0684a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="key_8h.html#a55cc40f04bf887c1000667caccb0684a">ECC_InitSanityCheck</a> (void)</td></tr>
<tr class="separator:a55cc40f04bf887c1000667caccb0684a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a1da569b8b6e5b3fa1196cc1b877e7f54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1da569b8b6e5b3fa1196cc1b877e7f54">&#9670;&nbsp;</a></span>CPrivKey</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::vector&lt;unsigned char, <a class="el" href="structsecure__allocator.html">secure_allocator</a>&lt;unsigned char&gt; &gt; <a class="el" href="key_8h.html#a1da569b8b6e5b3fa1196cc1b877e7f54">CPrivKey</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>secp256k1: const unsigned int PRIVATE_KEY_SIZE = 279; const unsigned int PUBLIC_KEY_SIZE = 65; const unsigned int SIGNATURE_SIZE = 72;</p>
<p>see www.keylength.com script supports up to 75 for single byte push <a class="el" href="structsecure__allocator.html">secure_allocator</a> is defined in allocators.h CPrivKey is a serialized private key, with all parameters included (279 bytes) </p>
<p class="definition">Definition at line <a class="el" href="key_8h_source.html#l00032">32</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a55cc40f04bf887c1000667caccb0684a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55cc40f04bf887c1000667caccb0684a">&#9670;&nbsp;</a></span>ECC_InitSanityCheck()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ECC_InitSanityCheck </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check that required EC support is available at runtime. </p>
<p class="definition">Definition at line <a class="el" href="key_8cpp_source.html#l00297">297</a> of file <a class="el" href="key_8cpp_source.html">key.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="init_8cpp_source.html#l00788">InitSanityCheck()</a>.</p>
</div>
</div>
<a id="a5ee69136607b1012d64a045ee44ccae2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ee69136607b1012d64a045ee44ccae2">&#9670;&nbsp;</a></span>ECC_Start()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECC_Start </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the elliptic curve support. May not be called twice without calling ECC_Stop first. </p>
<p class="definition">Definition at line <a class="el" href="key_8cpp_source.html#l00304">304</a> of file <a class="el" href="key_8cpp_source.html">key.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="init_8cpp_source.html#l00942">AppInit2()</a>, <a class="el" href="bench__dash_8cpp_source.html#l00012">main()</a>, and <a class="el" href="dash-tx_8cpp_source.html#l00492">Secp256k1Init::Secp256k1Init()</a>.</p>
</div>
</div>
<a id="a8fb68c634cf5491218253147eb4e04c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fb68c634cf5491218253147eb4e04c8">&#9670;&nbsp;</a></span>ECC_Stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECC_Stop </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deinitialize the elliptic curve support. No-op if ECC_Start wasn't called first. </p>
<p class="definition">Definition at line <a class="el" href="key_8cpp_source.html#l00323">323</a> of file <a class="el" href="key_8cpp_source.html">key.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="bench__dash_8cpp_source.html#l00012">main()</a>, <a class="el" href="init_8cpp_source.html#l00315">Shutdown()</a>, and <a class="el" href="dash-tx_8cpp_source.html#l00495">Secp256k1Init::~Secp256k1Init()</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="key_8h.html">key.h</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:10 for Dash Core by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>