resolve doc

Author: yinyiqian1

src/rpc/handlers/AccountMPTokenIssuances.cpp

@@ -51,12 +51,12 @@ namespace rpc {
 
 void
 AccountMPTokenIssuancesHandler::addMPTokenIssuance(
-    std::vector<MPTokenIssuancesResponse>& issuances,
+    std::vector<MPTokenIssuanceResponse>& issuances,
     ripple::SLE const& sle,
     ripple::AccountID const& account
 )
 {
-    MPTokenIssuancesResponse issuance;
+    MPTokenIssuanceResponse issuance;
 
     issuance.issuer = ripple::to_string(account);
     issuance.sequence = sle.getFieldU32(ripple::sfSequence);
@@ -203,7 +203,7 @@ void
 tag_invoke(
     boost::json::value_from_tag,
     boost::json::value& jv,
-    AccountMPTokenIssuancesHandler::MPTokenIssuancesResponse const& issuance
+    AccountMPTokenIssuancesHandler::MPTokenIssuanceResponse const& issuance
 )
 {
     auto obj = boost::json::object{

src/rpc/handlers/AccountMPTokenIssuances.hpp

@@ -60,7 +60,7 @@ class AccountMPTokenIssuancesHandler {
     /**
      * @brief A struct to hold data for one MPTokenIssuance response.
      */
-    struct MPTokenIssuancesResponse {
+    struct MPTokenIssuanceResponse {
         std::string issuer;
         uint32_t sequence{};
 
@@ -87,7 +87,7 @@ class AccountMPTokenIssuancesHandler {
      */
     struct Output {
         std::string account;
-        std::vector<MPTokenIssuancesResponse> issuances;
+        std::vector<MPTokenIssuanceResponse> issuances;
         std::string ledgerHash;
         uint32_t ledgerIndex{};
         bool validated = true;
@@ -158,33 +158,42 @@ class AccountMPTokenIssuancesHandler {
 
 private:
     /**
-     * @brief Populates an MPTokenIssuancesResponse from a ledger entry and adds it to the list.
+     * @brief Populates an MPTokenIssuanceResponse from a ledger entry and adds it to the list.
      */
     static void
     addMPTokenIssuance(
-        std::vector<MPTokenIssuancesResponse>& issuances,
+        std::vector<MPTokenIssuanceResponse>& issuances,
         ripple::SLE const& sle,
         ripple::AccountID const& account
     );
 
 private:
     /**
-     * @brief Convert the Output to a JSON object.
+     * @brief Convert the Output to a JSON object
+     *
+     * @param [out] jv The JSON object to convert to
+     * @param output The output to convert
      */
     friend void
     tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);
 
     /**
-     * @brief Convert a JSON object to Input type.
+     * @brief Convert a JSON object to Input type
+     *
+     * @param jv The JSON object to convert
+     * @return Input parsed from the JSON object
      */
     friend Input
     tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv);
 
     /**
-     * @brief Convert the MPTokenIssuancesResponse to a JSON object.
+     * @brief Convert the MPTokenIssuanceResponse to a JSON object
+     *
+     * @param [out] jv The JSON object to convert to
+     * @param line The MPTokenIssuance response to convert
      */
     friend void
-    tag_invoke(boost::json::value_from_tag, boost::json::value& jv, MPTokenIssuancesResponse const& issuance);
+    tag_invoke(boost::json::value_from_tag, boost::json::value& jv, MPTokenIssuanceResponse const& issuance);
 };
 
 }  // namespace rpc

src/rpc/handlers/AccountMPTokens.hpp

@@ -152,19 +152,28 @@ class AccountMPTokensHandler {
 
 private:
     /**
-     * @brief Convert the Output to a JSON object.
+     * @brief Convert the Output to a JSON object
+     *
+     * @param [out] jv The JSON object to convert to
+     * @param output The output to convert
      */
     friend void
     tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);
 
     /**
-     * @brief Convert a JSON object to Input type.
+     * @brief Convert a JSON object to Input type
+     *
+     * @param jv The JSON object to convert
+     * @return Input parsed from the JSON object
      */
     friend Input
     tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv);
 
     /**
-     * @brief Convert the MPTokenResponse to a JSON object.
+     * @brief Convert the MPTokenResponse to a JSON object
+     *
+     * @param [out] jv The JSON object to convert to
+     * @param line The MPToken response to convert
      */
     friend void
     tag_invoke(boost::json::value_from_tag, boost::json::value& jv, MPTokenResponse const& mptoken);