BTCPrivate
/
bitcore
mirror of https://github.com/BTCPrivate/bitcore.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix wrong jsdocs

This commit is contained in:
Esteban Ordano 2014-12-16 03:29:52 -03:00
parent e39543b730
commit ed9a9f6da9
4 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
gulpfile.js
View File

@ -78,10 +78,14 @@ gulp.task('coverage', shell.task(['istanbul cover _mocha -- --recursive']));
gulp.task('jsdoc', function() { gulp.task('jsdoc', function() {
return gulp.src(files.concat([jsdocReadme])) return gulp.src(files.concat([jsdocReadme]))
.pipe(jsdoc.parser()) .pipe(jsdoc.parser({
name: 'bitcore',
version: '0.8.0',
description: 'API Reference for the bitcore bitcoin javascript library'
}))
.pipe(jsdoc.generator('./apiref', { .pipe(jsdoc.generator('./apiref', {
path: 'ink-docstrap', path: 'ink-docstrap',
theme: 'flatly', theme: 'journal'
})); }));
}); });

2
lib/publickey.js
View File

@ -262,7 +262,7 @@ PublicKey.fromDER = PublicKey.fromBuffer = function(buf, strict) {
* Instantiate a PublicKey from a Point * Instantiate a PublicKey from a Point
* *
* @param {Point} point - A Point instance * @param {Point} point - A Point instance
* @param {boolean=true} compressed - whether to store this public key as compressed format * @param {boolean=} compressed - whether to store this public key as compressed format
* @returns {PublicKey} A new valid instance of PublicKey * @returns {PublicKey} A new valid instance of PublicKey
*/ */
PublicKey.fromPoint = function(point, compressed) { PublicKey.fromPoint = function(point, compressed) {

4
lib/script.js
View File

@ -551,7 +551,7 @@ Script.buildMultisigOut = function(pubkeys, m, opts) {
* @param {number} threshold amount of required signatures to spend the output * @param {number} threshold amount of required signatures to spend the output
* @param {Array} signatures signatures to append to the script * @param {Array} signatures signatures to append to the script
* @param {Object=} opts * @param {Object=} opts
* @param {boolean=false} opts.noSorting don't sort the given public keys before creating the script * @param {boolean=} opts.noSorting don't sort the given public keys before creating the script (false by default)
* @param {Script=} opts.cachedMultisig don't recalculate the redeemScript * @param {Script=} opts.cachedMultisig don't recalculate the redeemScript
* *
* @returns Script * @returns Script
@ -632,7 +632,7 @@ Script.buildScriptHashOut = function(script) {
* *
* @param {Buffer|string|PublicKey} publicKey * @param {Buffer|string|PublicKey} publicKey
* @param {Buffer} signature - the signature in DER cannonical encoding * @param {Buffer} signature - the signature in DER cannonical encoding
* @param {number=1} sigtype - the type of the signature (defaults to SIGHASH_ALL) * @param {number=} sigtype - the type of the signature (defaults to SIGHASH_ALL)
*/ */
Script.buildPublicKeyHashIn = function(publicKey, signature, sigtype) { Script.buildPublicKeyHashIn = function(publicKey, signature, sigtype) {
var script = new Script() var script = new Script()

4
lib/transaction/input/publickeyhash.js
View File

@ -25,7 +25,7 @@ inherits(PublicKeyHashInput, Input);
* @param {Transaction} transaction - the transaction to be signed * @param {Transaction} transaction - the transaction to be signed
* @param {PrivateKey} privateKey - the private key with which to sign the transaction * @param {PrivateKey} privateKey - the private key with which to sign the transaction
* @param {number} index - the index of the input in the transaction input vector * @param {number} index - the index of the input in the transaction input vector
* @param {number=Singature.SIGHASH_ALL} sigtype - the type of signature * @param {number=} sigtype - the type of signature, defaults to Signature.SIGHASH_ALL
* @param {Buffer=} hashData - the precalculated hash of the public key associated with the privateKey provided * @param {Buffer=} hashData - the precalculated hash of the public key associated with the privateKey provided
* @return {Array} of objects that can be * @return {Array} of objects that can be
*/ */
@ -54,7 +54,7 @@ PublicKeyHashInput.prototype.getSignatures = function(transaction, privateKey, i
* @param {Object} signature * @param {Object} signature
* @param {PublicKey} signature.publicKey * @param {PublicKey} signature.publicKey
* @param {Signature} signature.signature * @param {Signature} signature.signature
* @param {number=Signature.SIGHASH_ALL} signature.sigtype * @param {number=} signature.sigtype
* @return {PublicKeyHashInput} this, for chaining * @return {PublicKeyHashInput} this, for chaining
*/ */
PublicKeyHashInput.prototype.addSignature = function(transaction, signature) { PublicKeyHashInput.prototype.addSignature = function(transaction, signature) {