aboutsummaryrefslogtreecommitdiff
path: root/src/rpcserver.h
diff options
context:
space:
mode:
authorMichael Ford <fanquake@gmail.com>2014-10-30 10:14:08 +0800
committerMichael Ford <fanquake@gmail.com>2014-10-30 10:14:08 +0800
commit779204029463ed89fa74c52510017954f4cb2411 (patch)
tree5ceb9fc098d64095f4939143485daaac7d89203c /src/rpcserver.h
parent65e4e8427d900b27f579dc12af6c74b3ec628286 (diff)
downloadbitcoin-779204029463ed89fa74c52510017954f4cb2411.tar.xz
Update comments in rpcserver to be doxygen compatible
Diffstat (limited to 'src/rpcserver.h')
-rw-r--r--src/rpcserver.h39
1 files changed, 20 insertions, 19 deletions
diff --git a/src/rpcserver.h b/src/rpcserver.h
index d440035f15..cc444cef1f 100644
--- a/src/rpcserver.h
+++ b/src/rpcserver.h
@@ -1,6 +1,6 @@
// Copyright (c) 2010 Satoshi Nakamoto
// Copyright (c) 2009-2014 The Bitcoin developers
-// Distributed under the MIT/X11 software license, see the accompanying
+// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
#ifndef _BITCOINRPC_SERVER_H_
@@ -32,9 +32,10 @@ public:
virtual void close() = 0;
};
-/* Start RPC threads */
+/** Start RPC threads */
void StartRPCThreads();
-/* Alternative to StartRPCThreads for the GUI, when no server is
+/**
+ * Alternative to StartRPCThreads for the GUI, when no server is
* used. The RPC thread in this case is only used to handle timeouts.
* If real RPC threads have already been started this is a no-op.
*/
@@ -44,23 +45,23 @@ void StopRPCThreads();
/* Query whether RPC is running */
bool IsRPCRunning();
-/*
- Type-check arguments; throws JSONRPCError if wrong type given. Does not check that
- the right number of arguments are passed, just that any passed are the correct type.
- Use like: RPCTypeCheck(params, boost::assign::list_of(str_type)(int_type)(obj_type));
-*/
+/**
+ * Type-check arguments; throws JSONRPCError if wrong type given. Does not check that
+ * the right number of arguments are passed, just that any passed are the correct type.
+ * Use like: RPCTypeCheck(params, boost::assign::list_of(str_type)(int_type)(obj_type));
+ */
void RPCTypeCheck(const json_spirit::Array& params,
const std::list<json_spirit::Value_type>& typesExpected, bool fAllowNull=false);
-/*
- Check for expected keys/value types in an Object.
- Use like: RPCTypeCheck(object, boost::assign::map_list_of("name", str_type)("value", int_type));
-*/
+/**
+ * Check for expected keys/value types in an Object.
+ * Use like: RPCTypeCheck(object, boost::assign::map_list_of("name", str_type)("value", int_type));
+ */
void RPCTypeCheck(const json_spirit::Object& o,
const std::map<std::string, json_spirit::Value_type>& typesExpected, bool fAllowNull=false);
-/*
- Run func nSeconds from now. Uses boost deadline timers.
- Overrides previous timer <name> (if any).
+/**
+ * Run func nSeconds from now. Uses boost deadline timers.
+ * Overrides previous timer <name> (if any).
*/
void RPCRunLater(const std::string& name, boost::function<void(void)> func, int64_t nSeconds);
@@ -104,10 +105,10 @@ public:
extern const CRPCTable tableRPC;
-//
-// Utilities: convert hex-encoded Values
-// (throws error if not hex).
-//
+/**
+ * Utilities: convert hex-encoded Values
+ * (throws error if not hex).
+ */
extern uint256 ParseHashV(const json_spirit::Value& v, std::string strName);
extern uint256 ParseHashO(const json_spirit::Object& o, std::string strKey);
extern std::vector<unsigned char> ParseHexV(const json_spirit::Value& v, std::string strName);