clean up documentation

src/address.js

@@ -14,7 +14,7 @@ class Address {
   }
 
   /**
-   * @api Address.toLegacyAddress() toLegacyAddress() - Convert to Legacy Address
+   * @api Address.toLegacyAddress() toLegacyAddress()
    * @apiName toLegacyAddress
    * @apiGroup Address
    * @apiDescription Convert cashaddr to legacy address format
@@ -73,7 +73,7 @@ class Address {
   }
 
   /**
-   * @api Address.toCashAddress() toCashAddress() - Convert to bitcoincash: format
+   * @api Address.toCashAddress() toCashAddress()
    * @apiName toCashAddress
    * @apiGroup Address
    * @apiDescription Convert legacy to cashAddress format
@@ -120,7 +120,7 @@ class Address {
   }
 
   /**
-   * @api Address.hash160ToLegacy() hash160ToLegacy() - Convert hash160 to legacy address.
+   * @api Address.hash160ToLegacy() hash160ToLegacy()
    * @apiName hash160ToLegacy
    * @apiGroup Address
    * @apiDescription Convert hash160 to legacy address.
@@ -146,7 +146,7 @@ class Address {
   }
 
   /**
-   * @api Address.hash160ToCash() hash160ToCash() - Convert hash160 to cash address.
+   * @api Address.hash160ToCash() hash160ToCash()
    * @apiName hash160ToCash
    * @apiGroup Address
    * @apiDescription Convert hash160 to cash address.
@@ -255,7 +255,7 @@ class Address {
   }
 
   /**
-   * @api Address.isLegacyAddress() isLegacyAddress() - Detect if legacy address.
+   * @api Address.isLegacyAddress() isLegacyAddress()
    * @apiName isLegacyAddress
    * @apiGroup Address
    * @apiDescription Detect if legacy base58check encoded address.
@@ -291,7 +291,7 @@ class Address {
   }
 
   /**
-   * @api Address.isCashAddress() isCashAddress() - Detect if cashAddr address.
+   * @api Address.isCashAddress() isCashAddress()
    * @apiName isCashAddress
    * @apiGroup Address
    * @apiDescription Detect if cashAddr encoded address.
@@ -326,7 +326,7 @@ class Address {
   }
 
   /**
-   * @api Address.isHash160() isHash160() - Detect if an addess is a hash160.
+   * @api Address.isHash160() isHash160()
    * @apiName isHash160
    * @apiGroup Address
    * @apiDescription Detect if an addess is a hash160.
@@ -345,7 +345,7 @@ class Address {
   }
 
   /**
-   * @api Address.isMainnetAddress() isMainnetAddress() - Detect if mainnet address.
+   * @api Address.isMainnetAddress() isMainnetAddress()
    * @apiName isMainnetAddress
    * @apiGroup Address
    * @apiDescription Detect if mainnet address .
@@ -384,7 +384,7 @@ class Address {
   }
 
   /**
-   * @api Address.isTestnetAddress() isTestnetAddress() - Detect if testnet address.
+   * @api Address.isTestnetAddress() isTestnetAddress()
    * @apiName isTestnetAddress
    * @apiGroup Address
    * @apiDescription Detect if testnet address.
@@ -422,7 +422,7 @@ class Address {
   }
 
   /**
-   * @api Address.isRegTestAddress() isRegTestAddress() - Detect if regtest address.
+   * @api Address.isRegTestAddress() isRegTestAddress()
    * @apiName isRegTestAddress
    * @apiGroup Address
    * @apiDescription Detect if regtest address.
@@ -461,7 +461,7 @@ class Address {
   }
 
   /**
-   * @api Address.isP2PKHAddress() isP2PKHAddress() - Detect if p2pkh address.
+   * @api Address.isP2PKHAddress() isP2PKHAddress()
    * @apiName isP2PKHAddress
    * @apiGroup Address
    * @apiDescription Detect if p2pkh address.
@@ -498,7 +498,7 @@ class Address {
   }
 
   /**
-   * @api Address.isP2SHAddress() isP2SHAddress() - Detect if p2sh address.
+   * @api Address.isP2SHAddress() isP2SHAddress()
    * @apiName isP2SHAddress
    * @apiGroup Address
    * @apiDescription Detect if p2sh address.
@@ -534,7 +534,7 @@ class Address {
   }
 
   /**
-   * @api Address.detectAddressFormat() detectAddressFormat() - Detect address format.
+   * @api Address.detectAddressFormat() detectAddressFormat()
    * @apiName detectAddressFormat
    * @apiGroup Address
    * @apiDescription Detect address format.
@@ -572,7 +572,7 @@ class Address {
   }
 
   /**
-   * @api Address.detectAddressNetwork() detectAddressNetwork() - Detect address network.
+   * @api Address.detectAddressNetwork() detectAddressNetwork()
    * @apiName detectAddressNetwork
    * @apiGroup Address
    * @apiDescription Detect address network.
@@ -622,7 +622,7 @@ class Address {
   }
 
   /**
-   * @api Address.detectAddressType() detectAddressType() - Detect address type.
+   * @api Address.detectAddressType() detectAddressType()
    * @apiName detectAddressType
    * @apiGroup Address
    * @apiDescription Detect address type.
@@ -660,7 +660,7 @@ class Address {
   }
 
   /**
-   * @api Address.fromXPub() fromXPub() - Generates an address (xpub).
+   * @api Address.fromXPub() fromXPub()
    * @apiName fromXPub
    * @apiGroup Address
    * @apiDescription Generates an address for an extended public key (xpub).
@@ -698,7 +698,7 @@ class Address {
   }
 
   /**
-   * @api Address.fromOutputScript() fromOutputScript() - Detect an addess from an OutputScript..
+   * @api Address.fromOutputScript() fromOutputScript()
    * @apiName fromOutputScript
    * @apiGroup Address
    * @apiDescription Detect an addess from an OutputScript..

src/bitcoincash.js

@@ -15,7 +15,7 @@ class BitcoinCash {
   }
 
   /**
-   * @api BitcoinCash.toSatoshi() toSatoshi() - Converting Bitcoin Cash units to satoshi units.
+   * @api BitcoinCash.toSatoshi() toSatoshi()
    * @apiName toSatoshi
    * @apiGroup BitcoinCash
    * @apiDescription
@@ -48,7 +48,7 @@ class BitcoinCash {
   }
 
   /**
-   * @api BitcoinCash.toBitcoinCash() toBitcoinCash() - Converting satoshi units to Bitcoin Cash units.
+   * @api BitcoinCash.toBitcoinCash() toBitcoinCash()
    * @apiName toBitcoinCash
    * @apiGroup BitcoinCash
    * @apiDescription
@@ -81,7 +81,7 @@ class BitcoinCash {
   }
 
   /**
-   * @api BitcoinCash.toBits() toBits() - Converting satoshi units to Bits denomination.
+   * @api BitcoinCash.toBits() toBits()
    * @apiName toBits
    * @apiGroup BitcoinCash
    * @apiDescription
@@ -133,7 +133,7 @@ class BitcoinCash {
   // }
 
   /**
-   * @api BitcoinCash.signMessageWithPrivKey() signMessageWithPrivKey() - Sign message with private key.
+   * @api BitcoinCash.signMessageWithPrivKey() signMessageWithPrivKey()
    * @apiName signMessageWithPrivKey
    * @apiGroup BitcoinCash
    * @apiDescription
@@ -165,7 +165,7 @@ class BitcoinCash {
   }
 
   /**
-   * @api BitcoinCash.verifyMessage() verifyMessage() - Verify message.
+   * @api BitcoinCash.verifyMessage() verifyMessage()
    * @apiName verifyMessage
    * @apiGroup BitcoinCash
    * @apiDescription
@@ -189,7 +189,7 @@ class BitcoinCash {
   }
 
   /**
-   * @api BitcoinCash.encodeBase58Check() encodeBase58Check() - Encodes hex string as base58Check.
+   * @api BitcoinCash.encodeBase58Check() encodeBase58Check()
    * @apiName encodeBase58Check
    * @apiGroup BitcoinCash
    * @apiDescription
@@ -227,7 +227,7 @@ class BitcoinCash {
   }
 
   /**
-   * @api BitcoinCash.decodeBase58Check() decodeBase58Check() - Decodes base58Check encoded string to hex.
+   * @api BitcoinCash.decodeBase58Check() decodeBase58Check()
    * @apiName decodeBase58Check
    * @apiGroup BitcoinCash
    * @apiDescription
@@ -265,7 +265,7 @@ class BitcoinCash {
   }
 
   /**
-   * @api BitcoinCash.encodeBIP21() encodeBIP21() - Encodes address and options as BIP21 uri.
+   * @api BitcoinCash.encodeBIP21() encodeBIP21()
    * @apiName encodeBIP21
    * @apiGroup BitcoinCash
    * @apiDescription
@@ -306,7 +306,7 @@ class BitcoinCash {
   }
 
   /**
-   * @api BitcoinCash.decodeBIP21() decodeBIP21() - Decodes BIP21 uri.
+   * @api BitcoinCash.decodeBIP21() decodeBIP21()
    * @apiName decodeBIP21
    * @apiGroup BitcoinCash
    * @apiDescription
@@ -340,7 +340,7 @@ class BitcoinCash {
   }
 
   /**
-   * @api BitcoinCash.getByteCount() getByteCount() - Get byte count of transaction.
+   * @api BitcoinCash.getByteCount() getByteCount()
    * @apiName getByteCount
    * @apiGroup BitcoinCash
    * @apiDescription
@@ -458,7 +458,7 @@ class BitcoinCash {
   }
 
   /**
-   * @api BitcoinCash.encryptBIP38() encryptBIP38() - BIP38 encrypt privkey WIFs.
+   * @api BitcoinCash.encryptBIP38() encryptBIP38()
    * @apiName encryptBIP38
    * @apiGroup BitcoinCash
    * @apiDescription
@@ -486,7 +486,7 @@ class BitcoinCash {
   }
 
   /**
-   * @api BitcoinCash.decryptBIP38() decryptBIP38() - BIP38 encrypt privkey WIFs.
+   * @api BitcoinCash.decryptBIP38() decryptBIP38()
    * @apiName decryptBIP38
    * @apiGroup BitcoinCash
    * @apiDescription

src/blockbook.js

@@ -24,7 +24,7 @@ class Blockbook {
   }
 
   /**
-   * @api Blockbook.balance() balance() - Balance about an address.
+   * @api Blockbook.balance() balance()
    * @apiName Blockbook Balance
    * @apiGroup Blockbook
    * @apiDescription Return Balance about an address.
@@ -221,7 +221,7 @@ class Blockbook {
   }
 
   /**
-   * @api Blockbook.utxo()  utxo() - Get list of uxto for address.
+   * @api Blockbook.utxo()  utxo()
    * @apiName Blockbook Utxo
    * @apiGroup Blockbook
    * @apiDescription Return list of uxto for address.
@@ -307,7 +307,7 @@ class Blockbook {
   }
 
   /**
-   * @api Blockbook.tx()  tx() - Get details on a transaction.
+   * @api Blockbook.tx()  tx()
    * @apiName Blockbook Tx
    * @apiGroup Blockbook
    * @apiDescription Get details on a transaction.

src/blockchain.js

@@ -23,7 +23,7 @@ class Blockchain {
   }
 
   /**
-   * @api Blockchain.getBestBlockHash() getBestBlockHash() - Returns the hash of the best (tip) block in the longest blockchain.
+   * @api Blockchain.getBestBlockHash() getBestBlockHash()
    * @apiName getBestBlockHash
    * @apiGroup Blockchain
    * @apiDescription
@@ -54,7 +54,7 @@ class Blockchain {
   }
 
   /**
-   * @api Blockchain.getBlock() getBlock() - Return information about block hash.
+   * @api Blockchain.getBlock() getBlock()
    * @apiName getBlock
    * @apiGroup Blockchain
    * @apiDescription
@@ -102,7 +102,7 @@ class Blockchain {
   }
 
   /**
-   * @api Blockchain.getBlockchainInfo() getBlockchainInfo() - Returns an object containing various state info regarding blockchain processing.
+   * @api Blockchain.getBlockchainInfo() getBlockchainInfo()
    * @apiName getBlockchainInfo
    * @apiGroup Blockchain
    * @apiDescription
@@ -152,7 +152,7 @@ class Blockchain {
   }
 
   /**
-   * @api Blockchain.getBlockCount() getBlockCount() - Returns the number of blocks in the longest blockchain.
+   * @api Blockchain.getBlockCount() getBlockCount()
    * @apiName getBlockCount
    * @apiGroup Blockchain
    * @apiDescription
@@ -183,7 +183,7 @@ class Blockchain {
   }
 
   /**
-   * @api Blockchain.getBlockHash() getBlockHash() - Returns hash of block in best-block-chain at height provided.
+   * @api Blockchain.getBlockHash() getBlockHash()
    * @apiName getBlockHash
    * @apiGroup Blockchain
    * @apiDescription
@@ -216,7 +216,7 @@ class Blockchain {
   }
 
   /**
-   * @api Blockchain.getBlockHeader() getBlockHeader() - Return information about blockheader hash.
+   * @api Blockchain.getBlockHeader() getBlockHeader()
    * @apiName getBlockHeader
    * @apiGroup Blockchain
    * @apiDescription
@@ -281,7 +281,7 @@ class Blockchain {
   }
 
   /**
-   * @api Blockchain.getChainTips() getChainTips() - Return information about all known tips in the block tree.
+   * @api Blockchain.getChainTips() getChainTips()
    * @apiName getChainTips
    * @apiGroup Blockchain
    * @apiDescription
@@ -324,7 +324,7 @@ class Blockchain {
   }
 
   /**
-   * @api Blockchain.getDifficulty() getDifficulty() - Returns the proof-of-work difficulty as a multiple of the minimum difficulty.
+   * @api Blockchain.getDifficulty() getDifficulty()
    * @apiName getDifficulty
    * @apiGroup Blockchain
    * @apiDescription
@@ -387,7 +387,7 @@ class Blockchain {
   }
 
   /**
-   * @api Blockchain.getMempoolEntry() getMempoolEntry() - Returns mempool data for given transaction.
+   * @api Blockchain.getMempoolEntry() getMempoolEntry()
    * @apiName getMempoolEntry
    * @apiGroup Blockchain
    * @apiDescription
@@ -499,7 +499,7 @@ class Blockchain {
   }
 
   /**
-   * @api Blockchain.getMempoolInfo() getMempoolInfo() - Returns details on the active state of the TX memory pool.
+   * @api Blockchain.getMempoolInfo() getMempoolInfo()
    * @apiName getMempoolInfo
    * @apiGroup Blockchain
    * @apiDescription
@@ -535,7 +535,7 @@ class Blockchain {
   }
 
   /**
-   * @api Blockchain.getRawMempool() getRawMempool() - Returns all transaction ids in memory pool as a json array of string transaction ids.
+   * @api Blockchain.getRawMempool() getRawMempool()
    * @apiName getRawMempool
    * @apiGroup Blockchain
    * @apiDescription
@@ -582,7 +582,7 @@ class Blockchain {
   }
 
   /**
-   * @api Blockchain.getTxOut() getTxOut() - Returns details about an unspent transaction output.
+   * @api Blockchain.getTxOut() getTxOut()
    * @apiName getTxOut
    * @apiGroup Blockchain
    * @apiDescription
@@ -634,7 +634,7 @@ class Blockchain {
   }
 
   /**
-   * @api Blockchain.getTxOutProof() getTxOutProof() - Returns a hex-encoded proof that "txid" was included in a block.
+   * @api Blockchain.getTxOutProof() getTxOutProof()
    * @apiName getTxOutProof
    * @apiGroup Blockchain
    * @apiDescription
@@ -740,7 +740,7 @@ class Blockchain {
   }
 
   /**
-   * @api Blockchain.verifyTxOutProof() verifyTxOutProof() - Verifies that a proof points to a transaction in a block.
+   * @api Blockchain.verifyTxOutProof() verifyTxOutProof()
    * @apiName verifyTxOutProof
    * @apiGroup Blockchain
    * @apiDescription

src/control.js

@@ -22,7 +22,7 @@ class Control {
   }
 
   /**
-   * @api Control.getNetworkInfo() getNetworkInfo() - Get Network info
+   * @api Control.getNetworkInfo() getNetworkInfo()
    * @apiName getNetworkInfo
    * @apiGroup Control
    * @apiDescription Returns an object containing various network info.

src/crypto.js

@@ -3,7 +3,7 @@ const Bitcoin = require("bitcoincashjs-lib")
 
 class Crypto {
   /**
-   * @api Crypto.sha256() sha256() - Utility for creating sha256 hash.
+   * @api Crypto.sha256() sha256()
    * @apiName sha256
    * @apiGroup Crypto
    * @apiDescription Utility for creating sha256 hash digests of data
@@ -31,7 +31,7 @@ class Crypto {
   }
 
   /**
-   * @api Crypto.ripemd160() ripemd160()-Utility for creating ripemd160 hash.
+   * @api Crypto.ripemd160() ripemd160()
    * @apiName ripemd160
    * @apiGroup Crypto
    * @apiDescription Utility for creating ripemd160 hash digests of data
@@ -57,7 +57,7 @@ class Crypto {
   }
 
   /**
-   * @api Crypto.hash256() hash256() - Utility for creating double sha256 hash.
+   * @api Crypto.hash256() hash256()
    * @apiName hash256
    * @apiGroup Crypto
    * @apiDescription Utility for creating double sha256 hash digests of data.
@@ -83,7 +83,7 @@ class Crypto {
   }
 
   /**
-   * @api Crypto.hash160() hash160() - Utility for creating ripemd160(sha256()) hash.
+   * @api Crypto.hash160() hash160()
    * @apiName hash160
    * @apiGroup Crypto
    * @apiDescription Utility for creating ripemd160(sha256()) hash digests of data.
@@ -109,7 +109,7 @@ class Crypto {
   }
 
   /**
-   * @api Crypto.randomBytes() randomBytes() - Generates cryptographically strong pseudo-random data.
+   * @api Crypto.randomBytes() randomBytes()
    * @apiName randomBytes
    * @apiGroup Crypto
    * @apiDescription Generates cryptographically strong pseudo-random data. The size argument is a number indicating the number of bytes to generate.

src/ecpair.js

@@ -6,7 +6,7 @@ class ECPair {
     ECPair._address = address
   }
   /**
-   * @api Ecpair.fromWIF() fromWIF() - Generates an ECPair from a private key in wallet import format (WIF).
+   * @api Ecpair.fromWIF() fromWIF()
    * @apiName fromWIF
    * @apiGroup ECPair
    * @apiDescription Generates an ECPair from a private key in wallet import format (WIF). Follow these steps to go from a private key to a WIF. This method only works with a compressed private key.
@@ -35,7 +35,7 @@ class ECPair {
     return Bitcoin.ECPair.fromWIF(privateKeyWIF, bitcoincashBitcoinJSLib)
   }
   /**
-   * @api Ecpair.toWIF() toWIF() - Gets a private key in wallet import format from an ECPair.
+   * @api Ecpair.toWIF() toWIF()
    * @apiName toWIF
    * @apiGroup ECPair
    * @apiDescription Gets a private key in wallet import format from an ECPair.
@@ -69,7 +69,7 @@ class ECPair {
     return ecpair.verify(buffer, signature)
   }
   /**
-   * @api Ecpair.fromPublicKey() fromPublicKey() - Generates an ECPair from a public key buffer.
+   * @api Ecpair.fromPublicKey() fromPublicKey()
    * @apiName fromPublicKey
    * @apiGroup ECPair
    * @apiDescription Generates an ECPair from a public key buffer.
@@ -87,7 +87,7 @@ class ECPair {
     return Bitcoin.ECPair.fromPublicKeyBuffer(pubkeyBuffer)
   }
   /**
-   * @api Ecpair.toPublicKey() toPublicKey() - Get the public key of an ECPair as a buffer.
+   * @api Ecpair.toPublicKey() toPublicKey()
    * @apiName toPublicKey
    * @apiGroup ECPair
    * @apiDescription Get the public key of an ECPair as a buffer.
@@ -109,7 +109,7 @@ class ECPair {
     return ecpair.getPublicKeyBuffer()
   }
   /**
-   * @api Ecpair.toLegacyAddress() toLegacyAddress() - Get legacy address of ECPair.
+   * @api Ecpair.toLegacyAddress() toLegacyAddress()
    * @apiName toLegacyAddress
    * @apiGroup ECPair
    * @apiDescription Get legacy address of ECPair.
@@ -135,7 +135,7 @@ class ECPair {
     return ecpair.getAddress()
   }
   /**
-   * @api Ecpair.toCashAddress() toCashAddress() - Get cash address of ECPair.
+   * @api Ecpair.toCashAddress() toCashAddress()
    * @apiName toCashAddress
    * @apiGroup ECPair
    * @apiDescription Get cash address of ECPair.

src/hdnode.js

@@ -9,7 +9,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.fromSeed() fromSeed() - Create HDNode from Seed Buffer.
+   * @api HDNode.fromSeed() fromSeed()
    * @apiName fromSeed
    * @apiGroup HDNode
    * @apiDescription
@@ -46,7 +46,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.toLegacyAddress() toLegacyAddress() - Get legacy address of HDNode.
+   * @api HDNode.toLegacyAddress() toLegacyAddress()
    * @apiName toLegacyAddress
    * @apiGroup HDNode
    * @apiDescription
@@ -80,7 +80,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.toCashAddress() toCashAddress() - Get cash address of HDNode
+   * @api HDNode.toCashAddress() toCashAddress()
    * @apiName toCashAddress
    * @apiGroup HDNode
    * @apiDescription
@@ -114,7 +114,7 @@ class HDNode {
   }
 
   /**
-   * @api SLP.HDNode.toSLPAddress() toSLPAddress() - Get slp address of HDNode.
+   * @api SLP.HDNode.toSLPAddress() toSLPAddress()
    * @apiName toSLPAddress
    * @apiGroup SLP
    * @apiDescription Get slp address of HDNode.
@@ -148,7 +148,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.toWIF() toWIF() - Get private key in wallet import format (WIF) of HDNode.
+   * @api HDNode.toWIF() toWIF()
    * @apiName toWIF
    * @apiGroup HDNode
    * @apiDescription
@@ -182,7 +182,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.toXPub() toXPub() - Get extended public key of HDNode.
+   * @api HDNode.toXPub() toXPub()
    * @apiName toXPub
    * @apiGroup HDNode
    * @apiDescription
@@ -216,7 +216,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.toXPriv() toXPriv() - Get extended private key of HDNode.
+   * @api HDNode.toXPriv() toXPriv()
    * @apiName toXPriv
    * @apiGroup HDNode
    * @apiDescription
@@ -250,7 +250,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.toKeyPair() toKeyPair() - Get the ECPair of an HDNode.
+   * @api HDNode.toKeyPair() toKeyPair()
    * @apiName toKeyPair
    * @apiGroup HDNode
    * @apiDescription
@@ -282,7 +282,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.toPublicKey() toPublicKey() - Get the public key of an HDNode as a buffer.
+   * @api HDNode.toPublicKey() toPublicKey()
    * @apiName toPublicKey
    * @apiGroup HDNode
    * @apiDescription
@@ -316,7 +316,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.fromXPriv() fromXPriv() - Generate HDNode from extended private key.
+   * @api HDNode.fromXPriv() fromXPriv()
    * @apiName fromXPriv
    * @apiGroup HDNode
    * @apiDescription
@@ -339,7 +339,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.fromXPub() fromXPub() - Generate HDNode from extended public key.
+   * @api HDNode.fromXPub() fromXPub()
    * @apiName fromXPub
    * @apiGroup HDNode
    * @apiDescription
@@ -362,7 +362,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.derivePath() derivePath() - Derive child HDNode from path.
+   * @api HDNode.derivePath() derivePath()
    * @apiName derivePath
    * @apiGroup HDNode
    * @apiDescription
@@ -383,7 +383,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.derive() derive() - Derive non hardened child HDNode.
+   * @api HDNode.derive() derive()
    * @apiName derive
    * @apiGroup HDNode
    * @apiDescription
@@ -404,7 +404,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.deriveHardened() deriveHardened() - Derive hardened child HDNode.
+   * @api HDNode.deriveHardened() deriveHardened()
    * @apiName deriveHardened
    * @apiGroup HDNode
    * @apiDescription
@@ -425,7 +425,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.sign() sign() - Sign 32 byte hash encoded as a buffer.
+   * @api HDNode.sign() sign()
    * @apiName sign
    * @apiGroup HDNode
    * @apiDescription
@@ -455,7 +455,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.verify() verify() - Verify signed 32 byte hash encoded as a buffer.
+   * @api HDNode.verify() verify()
    * @apiName verify
    * @apiGroup HDNode
    * @apiDescription
@@ -499,7 +499,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.isPublic() isPublic() - Check if an HDNode can only derive public keys and children.
+   * @api HDNode.isPublic() isPublic()
    * @apiName isPublic
    * @apiGroup HDNode
    * @apiDescription
@@ -535,7 +535,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.isPrivate() isPrivate() - Check if an HDNode can derive both public and private keys and children.
+   * @api HDNode.isPrivate() isPrivate()
    * @apiName isPrivate
    * @apiGroup HDNode
    * @apiDescription
@@ -571,7 +571,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.toIdentifier() toIdentifier() - hash160 of Node’s public key.
+   * @api HDNode.toIdentifier() toIdentifier()
    * @apiName toIdentifier
    * @apiGroup HDNode
    * @apiDescription
@@ -607,7 +607,7 @@ class HDNode {
   }
 
   /**
-   * @api HDNode.createAccount() createAccount() - Create BIP32 account.
+   * @api HDNode.createAccount() createAccount()
    * @apiName createAccount
    * @apiGroup HDNode
    * @apiDescription

src/ipfs.js

@@ -53,7 +53,7 @@ class IPFS {
   }
 
   /**
-   * @api IPFS.createFileModelServer()  createFileModelServer() - Create a file model
+   * @api IPFS.createFileModelServer()  createFileModelServer()
    * @apiName createFileModelServer()
    * @apiGroup IPFS
    * @apiDescription Creates a new model on the server. If successful, will
@@ -131,7 +131,7 @@ class IPFS {
   }
 
   /**
-   * @api IPFS.uploadFileServer()  uploadFileServer() - Upload a file to IPFS
+   * @api IPFS.uploadFileServer()  uploadFileServer()
    * @apiName uploadFile()
    * @apiGroup IPFS
    * @apiDescription Upload a file to the FullStack.cash IPFS server. If
@@ -219,7 +219,7 @@ class IPFS {
   }
 
   /**
-   * @api IPFS.getStatus()  getStatus() - Check status of file upload
+   * @api IPFS.getStatus()  getStatus()
    * @apiName getStatus()
    * @apiGroup IPFS
    * @apiDescription Gets the status of the uploaded file. Will return an object
@@ -271,7 +271,7 @@ class IPFS {
     }
   }
   /**
-   * @api IPFS.createFileModelWeb()  createFileModelWeb() - Create a file model
+   * @api IPFS.createFileModelWeb()  createFileModelWeb()
    * @apiName createFileModelWeb()
    * @apiGroup IPFS
    * @apiDescription Creates a new model on the server. If successful, will
@@ -348,7 +348,7 @@ class IPFS {
   }
 
   /**
-   * @api IPFS.uploadFileWeb()  uploadFileWeb() - Upload a file to IPFS
+   * @api IPFS.uploadFileWeb()  uploadFileWeb()
    * @apiName uploadFileWeb()
    * @apiGroup IPFS
    * @apiDescription Upload a file to the FullStack.cash IPFS server. If

src/mnemonic.js

@@ -10,7 +10,7 @@ class Mnemonic {
   }
 
   /**
-   * @api Mnemonic.generate() generate() - Generate BIP39 mnemonic from entropy.
+   * @api Mnemonic.generate() generate()
    * @apiName generate
    * @apiGroup Mnemonic
    * @apiDescription
@@ -50,7 +50,7 @@ class Mnemonic {
   }
 
   /**
-   * @api Mnemonic.fromEntropy() fromEntropy() - Create mnemonic from entropy.
+   * @api Mnemonic.fromEntropy() fromEntropy()
    * @apiName fromEntropy
    * @apiGroup Mnemonic
    * @apiDescription
@@ -104,7 +104,7 @@ class Mnemonic {
   }
 
   /**
-   * @api Mnemonic.toEntropy() toEntropy() - Turn mnemonic to entropy.
+   * @api Mnemonic.toEntropy() toEntropy()
    * @apiName toEntropy
    * @apiGroup Mnemonic
    * @apiDescription
@@ -141,7 +141,7 @@ class Mnemonic {
   }
 
   /**
-   * @api Mnemonic.validate() validate() - Validate mnemonic.
+   * @api Mnemonic.validate() validate()
    * @apiName validate
    * @apiGroup Mnemonic
    * @apiDescription
@@ -181,7 +181,7 @@ class Mnemonic {
   }
 
   /**
-   * @api Mnemonic.toSeed() toSeed() - Create root seed from mnemonic
+   * @api Mnemonic.toSeed() toSeed()
    * @apiName toSeed
    * @apiGroup Mnemonic
    * @apiDescription
@@ -208,7 +208,7 @@ class Mnemonic {
   }
 
   /**
-   * @api Mnemonic.wordLists() wordLists() - Return mnemonic word lists.
+   * @api Mnemonic.wordLists() wordLists()
    * @apiName wordLists
    * @apiGroup Mnemonic
    * @apiDescription
@@ -234,7 +234,7 @@ class Mnemonic {
   }
 
   /**
-   * @api Mnemonic.toKeypairs() toKeypairs() - Returns an array of privateKeyWIF/publicAddress pairs.
+   * @api Mnemonic.toKeypairs() toKeypairs()
    * @apiName toKeypairs
    * @apiGroup Mnemonic
    * @apiDescription
@@ -290,7 +290,7 @@ class Mnemonic {
   }
 
   /**
-   * @api Mnemonic.findNearestWord() findNearestWord() - Returns nearest matching word from provided word list.
+   * @api Mnemonic.findNearestWord() findNearestWord()
    * @apiName findNearestWord
    * @apiGroup Mnemonic
    * @apiDescription

src/ninsight.js

@@ -31,7 +31,7 @@ class Ninsight {
   }
 
   /**
-   * @api Ninsight.utxo()  utxo() - Get list of uxto for address.
+   * @api Ninsight.utxo()  utxo()
    * @apiName Ninsight Utxo
    * @apiGroup Ninsight
    * @apiDescription Return list of uxto for address.

src/openbazaar.js

@@ -23,7 +23,7 @@ class OpenBazaar {
   }
 
   /**
-   * @api OpenBazaar.balance() balance() - Balance about an address.
+   * @api OpenBazaar.balance() balance()
    * @apiName OpenBazaar Balance
    * @apiGroup OpenBazaar
    * @apiDescription Return Balance about an address.
@@ -83,7 +83,7 @@ class OpenBazaar {
   }
 
   /**
-   * @api OpenBazaar.utxo()  utxo() - Get list of uxto for address.
+   * @api OpenBazaar.utxo()  utxo()
    * @apiName OpenBazaar Utxo
    * @apiGroup OpenBazaar
    * @apiDescription Return list of uxto for address.
@@ -135,7 +135,7 @@ class OpenBazaar {
   }
 
   /**
-   * @api OpenBazaar.tx()  tx() - Get details on a transaction.
+   * @api OpenBazaar.tx()  tx()
    * @apiName OpenBazaar Tx
    * @apiGroup OpenBazaar
    * @apiDescription Get details on a transaction.

src/price.js

@@ -1,6 +1,6 @@
 const axios = require("axios")
 /**
- * @api price.current() current() - Get current price.
+ * @api price.current() current()
  * @apiName Price.
  * @apiGroup Price
  * @apiDescription Return current price of BCH in multiple currencies.

src/raw-transactions.js

@@ -18,7 +18,7 @@ class RawTransactions {
   }
 
   /**
-   * @api RawTransactions.decodeRawTransaction() decodeRawTransaction() - Return an Array of JSON objects representing the serialized, hex-encoded transactions.
+   * @api RawTransactions.decodeRawTransaction() decodeRawTransaction()
    * @apiName decodeRawTransaction
    * @apiGroup RawTransactions
    * @apiDescription
@@ -115,7 +115,7 @@ class RawTransactions {
   }
 
   /**
-   * @api RawTransactions.decodeScript() decodeScript() - Decode hex-encoded scripts.
+   * @api RawTransactions.decodeScript() decodeScript()
    * @apiName decodeScript
    * @apiGroup RawTransactions
    * @apiDescription
@@ -182,7 +182,7 @@ class RawTransactions {
   }
 
   /**
-   * @api RawTransactions.getRawTransaction() getRawTransaction() - Return the raw transaction data.
+   * @api RawTransactions.getRawTransaction() getRawTransaction()
    * @apiName getRawTransaction
    * @apiGroup RawTransactions
    * @apiDescription
@@ -279,7 +279,7 @@ class RawTransactions {
   }
 
   /**
-   * @api RawTransactions.sendRawTransaction() sendRawTransaction() - Submits raw transaction (serialized, hex-encoded) to local node and network.
+   * @api RawTransactions.sendRawTransaction() sendRawTransaction()
    * @apiName sendRawTransaction
    * @apiGroup RawTransactions
    * @apiDescription

src/schnorr.js

@@ -14,7 +14,7 @@ class Schnorr {
   }
 
   /**
-   * @api Schnorr.sign() sign() - Sign a 32-byte message with the private key, returning a 64-byte signature.
+   * @api Schnorr.sign() sign()
    * @apiName sign
    * @apiGroup Schnorr
    * @apiDescription
@@ -41,7 +41,7 @@ class Schnorr {
   }
 
   /**
-   * @api Schnorr.verify() verify() - Verify a 64-byte signature of a 32-byte message against the public key.
+   * @api Schnorr.verify() verify()
    * @apiName verify
    * @apiGroup Schnorr
    * @apiDescription
@@ -73,7 +73,7 @@ class Schnorr {
   }
 
   /**
-   * @api Schnorr.batchVerify() batchVerify() - Verify a list of 64-byte signatures as a batch operation.
+   * @api Schnorr.batchVerify() batchVerify()
    * @apiName batchVerify
    * @apiGroup Schnorr
    * @apiDescription
@@ -135,7 +135,7 @@ class Schnorr {
   }
 
   /**
-   * @api Schnorr.nonInteractive() nonInteractive() - Aggregates multiple signatures of different private keys
+   * @api Schnorr.nonInteractive() nonInteractive()
    * @apiName nonInteractive
    * @apiGroup Schnorr
    * @apiDescription
@@ -184,7 +184,7 @@ class Schnorr {
   }
 
   /**
-   * @api Schnorr.computeEll() computeEll() - Generate ell which is the hash over all public keys participating in a session.
+   * @api Schnorr.computeEll() computeEll()
    * @apiName computeEll
    * @apiGroup Schnorr
    * @apiDescription
@@ -258,7 +258,7 @@ class Schnorr {
   }
 
   /**
-   * @api Schnorr.publicKeyCombine() publicKeyCombine() - Creates a special rogue-key-resistant.
+   * @api Schnorr.publicKeyCombine() publicKeyCombine()
    * @apiName publicKeyCombine
    * @apiGroup Schnorr
    * @apiDescription
@@ -276,7 +276,7 @@ class Schnorr {
   }
 
   /**
-   * @api Schnorr.sessionInitialize() sessionInitialize() - Creates a signing session.
+   * @api Schnorr.sessionInitialize() sessionInitialize()
    * @apiName sessionInitialize
    * @apiGroup Schnorr
    * @apiDescription
@@ -315,7 +315,7 @@ class Schnorr {
   }
 
   /**
-   * @api Schnorr.sessionNonceCombine() sessionNonceCombine() - Combines multiple nonces R_i into the combined nonce R.
+   * @api Schnorr.sessionNonceCombine() sessionNonceCombine()
    * @apiName sessionNonceCombine
    * @apiGroup Schnorr
    * @apiDescription
@@ -360,7 +360,7 @@ class Schnorr {
   }
 
   /**
-   * @api Schnorr.partialSign() partialSign() - Creates a partial signature s_i for a participant.
+   * @api Schnorr.partialSign() partialSign()
    * @apiName partialSign
    * @apiGroup Schnorr
    * @apiDescription
@@ -392,7 +392,7 @@ class Schnorr {
   }
 
   /**
-   * @api Schnorr.partialSignatureVerify() partialSignatureVerify() - Verifies a partial signature s_i against the participant's public key P_i.
+   * @api Schnorr.partialSignatureVerify() partialSignatureVerify()
    * @apiName partialSignatureVerify
    * @apiGroup Schnorr
    * @apiDescription
@@ -445,7 +445,7 @@ class Schnorr {
   }
 
   /**
-   * @api Schnorr.partialSignaturesCombine() partialSignaturesCombine() - Combines multiple partial signatures into a Schnorr signature.
+   * @api Schnorr.partialSignaturesCombine() partialSignaturesCombine()
    * @apiName partialSignaturesCombine
    * @apiGroup Schnorr
    * @apiDescription

src/slp/address.js

@@ -14,7 +14,7 @@ class Address extends BCHJSAddress {
   }
 
   /**
-   * @api SLP.Address.toSLPAddress() toSLPAddress() - Converting  to slpAddress format.
+   * @api SLP.Address.toSLPAddress() toSLPAddress()
    * @apiName toSLPAddress
    * @apiGroup SLP
    * @apiDescription Converting legacy or cashaddr to slpAddress format.
@@ -60,7 +60,7 @@ class Address extends BCHJSAddress {
   }
 
   /**
-   * @api SLP.Address.toCashAddress() toCashAddress() - Converting to cashAddress format.
+   * @api SLP.Address.toCashAddress() toCashAddress()
    * @apiName toCashAddress
    * @apiGroup SLP
    * @apiDescription Converting legacy or slpaddr to cashAddress format.
@@ -106,7 +106,7 @@ class Address extends BCHJSAddress {
   }
 
   /**
-   * @api SLP.Address.toLegacyAddress() toLegacyAddress() - Converting to legacy address format.
+   * @api SLP.Address.toLegacyAddress() toLegacyAddress()
    * @apiName toLegacyAddress
    * @apiGroup SLP
    * @apiDescription Converting cashaddr or slpaddr to legacy address format.
@@ -164,7 +164,7 @@ class Address extends BCHJSAddress {
   }
 
   /**
-   * @api SLP.Address.isSLPAddress() isSLPAddress() - Detect if slpAddr encoded address.
+   * @api SLP.Address.isSLPAddress() isSLPAddress()
    * @apiName isSLPAddress
    * @apiGroup SLP
    * @apiDescription Detect if slpAddr encoded address.
@@ -201,7 +201,7 @@ class Address extends BCHJSAddress {
   }
 
   /**
-   * @api SLP.Address.isMainnetAddress() isMainnetAddress() - Detect if mainnet address.
+   * @api SLP.Address.isMainnetAddress() isMainnetAddress()
    * @apiName isMainnetAddress
    * @apiGroup SLP
    * @apiDescription Detect if mainnet address.
@@ -255,7 +255,7 @@ class Address extends BCHJSAddress {
   }
 
   /**
-   * @api SLP.Address.isTestnetAddress() isTestnetAddress() - Detect if testnet address.
+   * @api SLP.Address.isTestnetAddress() isTestnetAddress()
    * @apiName isTestnetAddress
    * @apiGroup SLP
    * @apiDescription Detect if testnet address.
@@ -307,7 +307,7 @@ class Address extends BCHJSAddress {
     return bchAddress.isTestnetAddress(cashAddr)
   }
   /**
-   * @api SLP.Address.isP2PKHAddress() isP2PKHAddress() - Detect if p2pkh address.
+   * @api SLP.Address.isP2PKHAddress() isP2PKHAddress()
    * @apiName isP2PKHAddress
    * @apiGroup SLP
    * @apiDescription Detect if p2pkh address.
@@ -359,7 +359,7 @@ class Address extends BCHJSAddress {
     return bchAddress.isP2PKHAddress(cashAddr)
   }
   /**
-   * @api SLP.Address.isP2SHAddress() isP2SHAddress() - Detect if p2sh address.
+   * @api SLP.Address.isP2SHAddress() isP2SHAddress()
    * @apiName isP2SHAddress
    * @apiGroup SLP
    * @apiDescription Detect if p2sh address.
@@ -411,7 +411,7 @@ class Address extends BCHJSAddress {
     return bchAddress.isP2SHAddress(cashAddr)
   }
   /**
-   * @api SLP.Address.detectAddressFormat() detectAddressFormat() - Detect address format.
+   * @api SLP.Address.detectAddressFormat() detectAddressFormat()
    * @apiName detectAddressFormat
    * @apiGroup SLP
    * @apiDescription Detect address format.
@@ -464,7 +464,7 @@ class Address extends BCHJSAddress {
     return bchAddress.detectAddressFormat(address)
   }
   /**
-   * @api SLP.Address.detectAddressNetwork() detectAddressNetwork() - Detect address network.
+   * @api SLP.Address.detectAddressNetwork() detectAddressNetwork()
    * @apiName detectAddressNetwork
    * @apiGroup SLP
    * @apiDescription Detect address network.
@@ -516,7 +516,7 @@ class Address extends BCHJSAddress {
     return bchAddress.detectAddressNetwork(cashAddr)
   }
   /**
-   * @api SLP.Address.detectAddressType() detectAddressType() - Detect address type.
+   * @api SLP.Address.detectAddressType() detectAddressType()
    * @apiName detectAddressType
    * @apiGroup SLP
    * @apiDescription Detect address type.

src/slp/ecpair.js

@@ -13,7 +13,7 @@ class ECPair extends BCHJSECPair {
   }
   */
   /**
-   * @api SLP.ECPair.toSLPAddress() toSLPAddress() - Get slp address of ECPair.
+   * @api SLP.ECPair.toSLPAddress() toSLPAddress()
    * @apiName toSLPAddress
    * @apiGroup SLP
    * @apiDescription Get slp address of ECPair.

src/transaction-builder.js

@@ -37,7 +37,7 @@ class TransactionBuilder {
   }
 
   /**
-   * @api Transaction-Builder.addInput() addInput() - Add input to transaction.
+   * @api Transaction-Builder.addInput() addInput()
    * @apiName AddInput
    * @apiGroup TransactionBuilder
    * @apiDescription Add input to transaction.
@@ -66,7 +66,7 @@ class TransactionBuilder {
     this.p2shInput = true
   }
   /**
-   * @api Transaction-Builder.addOutput() addOutput() - Add output to transaction.
+   * @api Transaction-Builder.addOutput() addOutput()
    * @apiName AddOutput
    * @apiGroup TransactionBuilder
    * @apiDescription Add output to transaction.
@@ -90,7 +90,7 @@ class TransactionBuilder {
     }
   }
   /**
-   * @api Transaction-Builder.setLockTime() setLockTime() - Set locktime.
+   * @api Transaction-Builder.setLockTime() setLockTime()
    * @apiName SetLockTime
    * @apiGroup TransactionBuilder
    * @apiDescription Set locktime.
@@ -108,7 +108,7 @@ class TransactionBuilder {
     this.transaction.setLockTime(locktime)
   }
   /**
-   * @api Transaction-Builder.sign() sign() - Sign transaction..
+   * @api Transaction-Builder.sign() sign()
    * @apiName Sign.
    * @apiGroup TransactionBuilder
    * @apiDescription Sign transaction. It creates the unlocking script needed to spend an input. Each input has its own script and thus 'sign' must be called for each input even if the keyPair is the same..
@@ -145,7 +145,7 @@ class TransactionBuilder {
     )
   }
   /**
-   * @api Transaction-Builder.build() build() - Build transaction.
+   * @api Transaction-Builder.build() build()
    * @apiName Build.
    * @apiGroup TransactionBuilder
    * @apiDescription Build transaction.

src/util.js

@@ -18,7 +18,7 @@ class Util {
   }
 
   /**
-   * @api util.validateAddress() validateAddress() - Get information about the given bitcoin address.
+   * @api util.validateAddress() validateAddress()
    * @apiName Validate Address.
    * @apiGroup Util
    * @apiDescription Return information about the given bitcoin address.