diff options
| author | sje <sje3000@gmail.com> | 2013-10-29 22:29:44 +1100 |
|---|---|---|
| committer | Wladimir J. van der Laan <laanwj@gmail.com> | 2013-11-13 14:54:29 +0100 |
| commit | a6099ef319a73e2255dca77065600abb22c4f5f8 (patch) | |
| tree | 4b02c150d44351ceac018a0557667f242ea68f22 /src/bitcoinrpc.h | |
| parent | 2830a9051d19fa8ba29e26ef0440107a13b15975 (diff) | |
| download | bitcoin-a6099ef319a73e2255dca77065600abb22c4f5f8.tar.xz | |
Issue #1865 - Clean up RPC help messages
Based on the proposal, update the help message of rpc methods
- strings arguments are in double quotes rather than square brackets
- numeric arguments have no quotes (and no default value)
- optional parameters are surrounded by round brackets
- json arguments are strings but don't use double quotes
Added 3 sections for the details
- Arguments: lists each argument, it's type, required or not, a default, and a description
- Result: The method result, with json format if applicable, type, and a description
- Examples: examples calls using bitcoin-cli and curl for json rpc call
Problems
- maybe this is too verbose
- lines might be too long
- description are not good or complete
- examples may be too much
Diffstat (limited to 'src/bitcoinrpc.h')
| -rw-r--r-- | src/bitcoinrpc.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/src/bitcoinrpc.h b/src/bitcoinrpc.h index 46e3ba4f1d..9025ff9216 100644 --- a/src/bitcoinrpc.h +++ b/src/bitcoinrpc.h @@ -153,6 +153,9 @@ extern json_spirit::Value ValueFromAmount(int64_t amount); extern double GetDifficulty(const CBlockIndex* blockindex = NULL); extern std::string HexBits(unsigned int nBits); extern std::string HelpRequiringPassphrase(); +extern std::string HelpExampleCli(std::string methodname, std::string args); +extern std::string HelpExampleRpc(std::string methodname, std::string args); + extern void EnsureWalletIsUnlocked(); extern json_spirit::Value getconnectioncount(const json_spirit::Array& params, bool fHelp); // in rpcnet.cpp |