aboutsummaryrefslogtreecommitdiff
path: root/src/rpc/util.h
diff options
context:
space:
mode:
authorMarcoFalke <falke.marco@gmail.com>2018-12-04 13:30:06 -0500
committerMarcoFalke <falke.marco@gmail.com>2018-12-04 13:47:49 -0500
commitfabca42c68ee4cdff08d30e91412ccf1de6d7b41 (patch)
treeaeaab7e7d2bbba758858daa52f7b91580a8c6636 /src/rpc/util.h
parentfafd040f7321294d5e4335b9581a6bd46a714c37 (diff)
downloadbitcoin-fabca42c68ee4cdff08d30e91412ccf1de6d7b41.tar.xz
RPCHelpMan: Add space after colons in extended description
Also, add doxygen comment to ToDescriptionString
Diffstat (limited to 'src/rpc/util.h')
-rw-r--r--src/rpc/util.h17
1 files changed, 15 insertions, 2 deletions
diff --git a/src/rpc/util.h b/src/rpc/util.h
index 11238ce9f7..1d1df2c635 100644
--- a/src/rpc/util.h
+++ b/src/rpc/util.h
@@ -88,8 +88,21 @@ struct RPCArg {
assert(type == Type::ARR || type == Type::OBJ);
}
- std::string ToString(bool oneline = false) const;
- std::string ToStringObj() const;
+ /**
+ * Return the type string of the argument.
+ * Set oneline to allow it to be overrided by a custom oneline type string (m_oneline_description).
+ */
+ std::string ToString(bool oneline) const;
+ /**
+ * Return the type string of the argument when it is in an object (dict).
+ * Set oneline to get the oneline representation (less whitespace)
+ */
+ std::string ToStringObj(bool oneline) const;
+ /**
+ * Return the description string, including the argument type and whether
+ * the argument is required.
+ * implicitly_required is set for arguments in an array, which are neither optional nor required.
+ */
std::string ToDescriptionString(bool implicitly_required = false) const;
};