Skip to content

Commit

Permalink
API doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
kjur committed Jan 22, 2017
1 parent 77a87f5 commit a318566
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 35 deletions.
50 changes: 25 additions & 25 deletions api/symbols/KJUR.crypto.ECDSA.html
Original file line number Diff line number Diff line change
Expand Up @@ -525,9 +525,9 @@ <h1 class="classTitle">
</tr>

<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">KJUR.crypto.ECDSA.<b><a href="../symbols/KJUR.crypto.ECDSA.html#.generateKeyPairHex">generateKeyPairHex</a></b>()
<div class="fixedFont"><b><a href="../symbols/KJUR.crypto.ECDSA.html#generateKeyPairHex">generateKeyPairHex</a></b>()
</div>
<div class="description">generate a EC key pair</div>
</td>
Expand All @@ -546,18 +546,18 @@ <h1 class="classTitle">
</tr>

<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">KJUR.crypto.ECDSA.<b><a href="../symbols/KJUR.crypto.ECDSA.html#.getPublicKeyXYHex">getPublicKeyXYHex</a></b>()
<div class="fixedFont"><b><a href="../symbols/KJUR.crypto.ECDSA.html#getPublicKeyXYHex">getPublicKeyXYHex</a></b>()
</div>
<div class="description">get X and Y hexadecimal string value of public key</div>
</td>
</tr>

<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">KJUR.crypto.ECDSA.<b><a href="../symbols/KJUR.crypto.ECDSA.html#.getShortNISTPCurveName">getShortNISTPCurveName</a></b>()
<div class="fixedFont"><b><a href="../symbols/KJUR.crypto.ECDSA.html#getShortNISTPCurveName">getShortNISTPCurveName</a></b>()
</div>
<div class="description">get NIST curve short name such as "P-256" or "P-384"</div>
</td>
Expand Down Expand Up @@ -627,18 +627,18 @@ <h1 class="classTitle">
</tr>

<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">KJUR.crypto.ECDSA.<b><a href="../symbols/KJUR.crypto.ECDSA.html#.signHex">signHex</a></b>(hashHex, privHex)
<div class="fixedFont"><b><a href="../symbols/KJUR.crypto.ECDSA.html#signHex">signHex</a></b>(hashHex, privHex)
</div>
<div class="description">signing to message hash</div>
</td>
</tr>

<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">KJUR.crypto.ECDSA.<b><a href="../symbols/KJUR.crypto.ECDSA.html#.verifyHex">verifyHex</a></b>(hashHex, sigHex, pubkeyHex)
<div class="fixedFont"><b><a href="../symbols/KJUR.crypto.ECDSA.html#verifyHex">verifyHex</a></b>(hashHex, sigHex, pubkeyHex)
</div>
<div class="description">verifying signature with message hash and public key</div>
</td>
Expand Down Expand Up @@ -859,11 +859,11 @@ <h1 class="classTitle">

<hr />

<a name=".generateKeyPairHex"> </a>
<div class="fixedFont">&lt;static&gt;
<a name="generateKeyPairHex"> </a>
<div class="fixedFont">

<span class="light">{Array}</span>
<span class="light">KJUR.crypto.ECDSA.</span><b>generateKeyPairHex</b>()
<b>generateKeyPairHex</b>()

</div>
<div class="description">
Expand Down Expand Up @@ -964,11 +964,11 @@ <h1 class="classTitle">

<hr />

<a name=".getPublicKeyXYHex"> </a>
<div class="fixedFont">&lt;static&gt;
<a name="getPublicKeyXYHex"> </a>
<div class="fixedFont">

<span class="light">{Array}</span>
<span class="light">KJUR.crypto.ECDSA.</span><b>getPublicKeyXYHex</b>()
<b>getPublicKeyXYHex</b>()

</div>
<div class="description">
Expand Down Expand Up @@ -1007,11 +1007,11 @@ <h1 class="classTitle">

<hr />

<a name=".getShortNISTPCurveName"> </a>
<div class="fixedFont">&lt;static&gt;
<a name="getShortNISTPCurveName"> </a>
<div class="fixedFont">

<span class="light">{String}</span>
<span class="light">KJUR.crypto.ECDSA.</span><b>getShortNISTPCurveName</b>()
<b>getShortNISTPCurveName</b>()

</div>
<div class="description">
Expand Down Expand Up @@ -1391,11 +1391,11 @@ <h1 class="classTitle">

<hr />

<a name=".signHex"> </a>
<div class="fixedFont">&lt;static&gt;
<a name="signHex"> </a>
<div class="fixedFont">

<span class="light">{String}</span>
<span class="light">KJUR.crypto.ECDSA.</span><b>signHex</b>(hashHex, privHex)
<b>signHex</b>(hashHex, privHex)

</div>
<div class="description">
Expand Down Expand Up @@ -1451,11 +1451,11 @@ <h1 class="classTitle">

<hr />

<a name=".verifyHex"> </a>
<div class="fixedFont">&lt;static&gt;
<a name="verifyHex"> </a>
<div class="fixedFont">

<span class="light">{Boolean}</span>
<span class="light">KJUR.crypto.ECDSA.</span><b>verifyHex</b>(hashHex, sigHex, pubkeyHex)
<b>verifyHex</b>(hashHex, sigHex, pubkeyHex)

</div>
<div class="description">
Expand Down
10 changes: 5 additions & 5 deletions api/symbols/src/ecdsa-modified-1.0.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
<span class='line'>111</span> </span><span class="WHIT"> </span><span class="COMM">/**
<span class='line'>112</span> * get X and Y hexadecimal string value of public key
<span class='line'>113</span> * @name getPublicKeyXYHex
<span class='line'>114</span> * @memberOf KJUR.crypto.ECDSA
<span class='line'>114</span> * @memberOf KJUR.crypto.ECDSA#
<span class='line'>115</span> * @function
<span class='line'>116</span> * @return {Array} associative array of x and y value of public key
<span class='line'>117</span> * @since ecdsa-modified 1.0.5 jsrsasign 5.0.14
Expand All @@ -144,7 +144,7 @@
<span class='line'>137</span> </span><span class="WHIT"> </span><span class="COMM">/**
<span class='line'>138</span> * get NIST curve short name such as "P-256" or "P-384"
<span class='line'>139</span> * @name getShortNISTPCurveName
<span class='line'>140</span> * @memberOf KJUR.crypto.ECDSA
<span class='line'>140</span> * @memberOf KJUR.crypto.ECDSA#
<span class='line'>141</span> * @function
<span class='line'>142</span> * @return {String} short NIST P curve name such as "P-256" or "P-384" if it's NIST P curve otherwise null;
<span class='line'>143</span> * @since ecdsa-modified 1.0.5 jsrsasign 5.0.14
Expand All @@ -165,7 +165,7 @@
<span class='line'>158</span> </span><span class="WHIT"> </span><span class="COMM">/**
<span class='line'>159</span> * generate a EC key pair
<span class='line'>160</span> * @name generateKeyPairHex
<span class='line'>161</span> * @memberOf KJUR.crypto.ECDSA
<span class='line'>161</span> * @memberOf KJUR.crypto.ECDSA#
<span class='line'>162</span> * @function
<span class='line'>163</span> * @return {Array} associative array of hexadecimal string of private and public key
<span class='line'>164</span> * @since ecdsa-modified 1.0.1
Expand Down Expand Up @@ -200,7 +200,7 @@
<span class='line'>193</span> </span><span class="WHIT"> </span><span class="COMM">/**
<span class='line'>194</span> * signing to message hash
<span class='line'>195</span> * @name signHex
<span class='line'>196</span> * @memberOf KJUR.crypto.ECDSA
<span class='line'>196</span> * @memberOf KJUR.crypto.ECDSA#
<span class='line'>197</span> * @function
<span class='line'>198</span> * @param {String} hashHex hexadecimal string of hash value of signing message
<span class='line'>199</span> * @param {String} privHex hexadecimal string of EC private key
Expand Down Expand Up @@ -250,7 +250,7 @@
<span class='line'>243</span> </span><span class="WHIT"> </span><span class="COMM">/**
<span class='line'>244</span> * verifying signature with message hash and public key
<span class='line'>245</span> * @name verifyHex
<span class='line'>246</span> * @memberOf KJUR.crypto.ECDSA
<span class='line'>246</span> * @memberOf KJUR.crypto.ECDSA#
<span class='line'>247</span> * @function
<span class='line'>248</span> * @param {String} hashHex hexadecimal string of hash value of signing message
<span class='line'>249</span> * @param {String} sigHex hexadecimal string of signature value
Expand Down
10 changes: 5 additions & 5 deletions ecdsa-modified-1.0.js
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ KJUR.crypto.ECDSA = function(params) {
/**
* get X and Y hexadecimal string value of public key
* @name getPublicKeyXYHex
* @memberOf KJUR.crypto.ECDSA
* @memberOf KJUR.crypto.ECDSA#
* @function
* @return {Array} associative array of x and y value of public key
* @since ecdsa-modified 1.0.5 jsrsasign 5.0.14
Expand All @@ -137,7 +137,7 @@ KJUR.crypto.ECDSA = function(params) {
/**
* get NIST curve short name such as "P-256" or "P-384"
* @name getShortNISTPCurveName
* @memberOf KJUR.crypto.ECDSA
* @memberOf KJUR.crypto.ECDSA#
* @function
* @return {String} short NIST P curve name such as "P-256" or "P-384" if it's NIST P curve otherwise null;
* @since ecdsa-modified 1.0.5 jsrsasign 5.0.14
Expand All @@ -158,7 +158,7 @@ KJUR.crypto.ECDSA = function(params) {
/**
* generate a EC key pair
* @name generateKeyPairHex
* @memberOf KJUR.crypto.ECDSA
* @memberOf KJUR.crypto.ECDSA#
* @function
* @return {Array} associative array of hexadecimal string of private and public key
* @since ecdsa-modified 1.0.1
Expand Down Expand Up @@ -193,7 +193,7 @@ KJUR.crypto.ECDSA = function(params) {
/**
* signing to message hash
* @name signHex
* @memberOf KJUR.crypto.ECDSA
* @memberOf KJUR.crypto.ECDSA#
* @function
* @param {String} hashHex hexadecimal string of hash value of signing message
* @param {String} privHex hexadecimal string of EC private key
Expand Down Expand Up @@ -243,7 +243,7 @@ KJUR.crypto.ECDSA = function(params) {
/**
* verifying signature with message hash and public key
* @name verifyHex
* @memberOf KJUR.crypto.ECDSA
* @memberOf KJUR.crypto.ECDSA#
* @function
* @param {String} hashHex hexadecimal string of hash value of signing message
* @param {String} sigHex hexadecimal string of signature value
Expand Down

0 comments on commit a318566

Please sign in to comment.