Skip to content

Commands are missing documentation. #4

@tomc974

Description

@tomc974

Depends on issue #1.

Once type signatures have been added to a command, they should be documented appropriately with TypeDoc comments. This issue will be used to track the progress on this task.

  • AddMultiSigAddress
  • AddNode
  • AppendRawChange
  • AppendRawData
  • AppendRawExchange
  • AppendRawTransaction
  • ApproveFrom
  • BackupWallet
  • ClearMemPool
  • CombineUnspent
  • CompleteRawExchange
  • Create
  • CreateFrom
  • CreateKeyPairs
  • CreateMultiSig
  • CreateRawExchange
  • CreateRawSendFrom
  • CreateRawTransaction
  • DecodeRawExchange
  • DecodeRawTransaction
  • DisableRawTransaction
  • DumpPrivKey
  • DumpWallet
  • EncryptWallet
  • GetAddedNodeInfo
  • GetAddressBalances
  • GetAddresses
  • GetAddressTransaction
  • GetAssetTransaction
  • GetBlock
  • GetBlockchainInfo
  • GetBlockchainParams
  • GetBlockHash
  • GetInfo
  • GetMemPoolInfo
  • GetMultiBalances
  • GetNetworkInfo
  • GetNewAddress
  • GetPeerInfo
  • GetRawMemPool
  • GetRawTransaction
  • GetRuntimeParams
  • GetStreamItem
  • GetTotalBalances
  • GetTxOut
  • GetTxOutData
  • GetWalletInfo
  • GetWalletTransaction
  • Grant
  • GrantFrom
  • GrantWithData
  • GrantWithDataFrom
  • Help
  • ImportAddress
  • ImportPrivKey
  • ImportWallet
  • Issue
  • IssueFrom
  • IssueMore
  • IssueMoreFrom
  • ListAddresses
  • ListAddressTransactions
  • ListAssets
  • ListAssetTransactions
  • ListBlocks
  • ListLockUnspent
  • ListPermissions
  • ListStreamBlockItems
  • ListStreamItems
  • ListStreamKeyItems
  • ListStreamKeys
  • ListStreamPublisherItems
  • ListStreamPublishers
  • ListStreams
  • ListUnspent
  • ListUpgrades
  • ListWalletTransactions
  • LockUnspent
  • Pause
  • Ping
  • PrepareLockUnspent
  • PrepareLockUnspentFrom
  • Publish
  • PublishFrom
  • Resume
  • Revoke
  • RevokeFrom
  • Send
  • SendAsset
  • SendAssetFrom
  • SendFrom
  • SendRawTransaction
  • SendWithData
  • SendWithDataFrom
  • SetLastBlock
  • SetRuntimeParam
  • SignMessage
  • SignRawTransaction
  • Stop
  • Subscribe
  • Unsubscribe
  • ValidateAddress
  • VerifyMessage
  • WalletLock
  • WalletPassphrase
  • WalletPassphraseChange

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions