diff --git a/src/rpc/Errors.cpp b/src/rpc/Errors.cpp index 807eb842a..ba1c12ccd 100644 --- a/src/rpc/Errors.cpp +++ b/src/rpc/Errors.cpp @@ -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) { diff --git a/src/rpc/Errors.hpp b/src/rpc/Errors.hpp index b79e2cdec..8790a3cc7 100644 --- a/src/rpc/Errors.hpp +++ b/src/rpc/Errors.hpp @@ -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 diff --git a/src/rpc/common/AnyHandler.hpp b/src/rpc/common/AnyHandler.hpp index 3c305d080..c818a2e2c 100644 --- a/src/rpc/common/AnyHandler.hpp +++ b/src/rpc/common/AnyHandler.hpp @@ -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 diff --git a/src/rpc/common/Specs.hpp b/src/rpc/common/Specs.hpp index f3996da37..5a5e6eaa7 100644 --- a/src/rpc/common/Specs.hpp +++ b/src/rpc/common/Specs.hpp @@ -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;