ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2026-09-28 07:58:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix doxy

Browse Source
This commit is contained in:
Alex Kremer
2026-08-12 14:34:10 +01:00
parent aef5b353a2
commit 9d4ee75bd0
4 changed files with 19 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/rpc/Errors.cpp
View File

@@ -24,6 +24,16 @@ using namespace std;
namespace rpc {
/**
* @brief Stream a Status in human readable form.
*
* Declared in rpcspec but implemented here: rendering a code needs Clio's
* getErrorInfo/getEtlErrorInfo tables and xrpl::RPC::getErrorInfo.
*
* @param stream The stream to write to
* @param status The status to write
* @return The same stream
*/
std::ostream&
operator<<(std::ostream& stream, Status const& status)
{

12
src/rpc/Errors.hpp
View File

@@ -10,7 +10,7 @@
namespace rpc {
/**
* @brief Holds info about a particular @ref ClioError.
* @brief Holds info about a particular ClioError.
*/
struct ClioErrorInfo {
ClioError const code;
@@ -19,7 +19,7 @@ struct ClioErrorInfo {
};
/**
* @brief Holds info about a particular @ref rpc::EtlError.
* @brief Holds info about a particular rpc::EtlError.
*/
struct EtlErrorInfo {
EtlError const code;
@@ -28,7 +28,7 @@ struct EtlErrorInfo {
};
/**
* @brief A globally available @ref rpc::Status that represents a successful state.
* @brief A globally available rpc::Status that represents a successful state.
*/
static Status gOk;
@@ -51,7 +51,7 @@ EtlErrorInfo const&
getEtlErrorInfo(EtlError code);
/**
* @brief Generate JSON from a @ref rpc::Status.
* @brief Generate JSON from a rpc::Status.
*
* @param status The status object
* @return The JSON output
@@ -60,7 +60,7 @@ boost::json::object
makeError(Status const& status);
/**
* @brief Generate JSON from a @ref rpc::RippledError.
* @brief Generate JSON from a rpc::RippledError.
*
* @param err The rippled error
* @param customError A custom error
@@ -75,7 +75,7 @@ makeError(
);
/**
* @brief Generate JSON from a @ref rpc::ClioError.
* @brief Generate JSON from a rpc::ClioError.
*
* @param err The clio's custom error
* @param customError A custom error

2
src/rpc/common/AnyHandler.hpp
View File

@@ -60,7 +60,7 @@ public:
*
* @param value The JSON to process
* @param ctx Request context
* @return JSON result or @ref Status on error
* @return JSON result or Status on error
*/
[[nodiscard]] ReturnType
process(boost::json::value const& value, Context const& ctx) const

4
src/rpc/common/Specs.hpp
View File

@@ -54,7 +54,7 @@ struct FieldSpec final {
* @brief Processes the passed JSON value using the stored processors.
*
* @param value The JSON value to validate and/or modify
* @return Nothing on success; @ref Status on error
* @return Nothing on success; Status on error
*/
[[nodiscard]] MaybeError
process(boost::json::value& value) const;
@@ -106,7 +106,7 @@ struct RpcSpec final {
* @brief Processes the passed JSON value using the stored field specs.
*
* @param value The JSON value to validate and/or modify
* @return Nothing on success; @ref Status on error
* @return Nothing on success; Status on error
*/
[[nodiscard]] MaybeError
process(boost::json::value& value) const;