fix JSDoc comments

Author: Patel-Raj11

packages/xrpl/src/models/common/index.ts

@@ -220,9 +220,7 @@ export interface PriceData {
 }
 
 /**
- * MPTokenMetadata object as per the XLS-89 standard.
- * Represents metadata for a Multi-Purpose Token using long-form field names.
- * This format is more human-readable and is recommended for client-side usage.
+ * {@link MPTokenMetadata} object as per the XLS-89 standard.
  * Use {@link encodeMPTokenMetadata} utility function to convert to a compact hex string for on-ledger storage.
  * Use {@link decodeMPTokenMetadata} utility function to convert from a hex string to this format.
  */
@@ -243,6 +241,14 @@ export interface MPTokenMetadata {
    */
   name: string
 
+  /**
+   * Short description of the token.
+   * Any UTF-8 string.
+   *
+   * @example "A yield-bearing stablecoin backed by short-term U.S. Treasuries"
+   */
+  desc?: string
+
   /**
    * URI to the token icon.
    * Can be a `hostname/path` (HTTPS assumed) or full URI for other protocols (e.g., ipfs://).
@@ -259,22 +265,6 @@ export interface MPTokenMetadata {
    */
   asset_class: string
 
-  /**
-   * The name of the issuer account.
-   * Any UTF-8 string.
-   *
-   * @example "Example Yield Co."
-   */
-  issuer_name: string
-
-  /**
-   * Short description of the token.
-   * Any UTF-8 string.
-   *
-   * @example "A yield-bearing stablecoin backed by short-term U.S. Treasuries"
-   */
-  desc?: string
-
   /**
    * Optional subcategory of the asset class.
    * Required if `asset_class` is "rwa".
@@ -284,6 +274,14 @@ export interface MPTokenMetadata {
    */
   asset_subclass?: string
 
+  /**
+   * The name of the issuer account.
+   * Any UTF-8 string.
+   *
+   * @example "Example Yield Co."
+   */
+  issuer_name: string
+
   /**
    * List of related URIs (site, dashboard, social media, documentation, etc.).
    * Each URI object contains the link, its category, and a human-readable title.
@@ -300,8 +298,7 @@ export interface MPTokenMetadata {
 }
 
 /**
- * MPTokenMetadataUri object as per the XLS-89 standard.
- * Represents a URI entry in the MPTokenMetadata using long-form field names.
+ * {@link MPTokenMetadataUri} object as per the XLS-89 standard.
  * Used within the `uris` array of {@link MPTokenMetadata}.
  */
 export interface MPTokenMetadataUri {

packages/xrpl/src/models/transactions/common.ts

@@ -1002,7 +1002,7 @@ export function isDomainID(domainID: unknown): domainID is string {
 
 /**
  * Shortens long field names to their compact form equivalents.
- * Reverse operation of expandKeys.
+ * Reverse operation of {@link expandKeys}.
  *
  * @param input - Object with potentially long field names.
  * @param mappings - Array of field mappings with long and compact names.
@@ -1040,15 +1040,15 @@ function shortenKeys(
 }
 
 /**
- * Encodes MPTokenMetadata object to a hex string.
+ * Encodes {@link MPTokenMetadata} object to a hex string.
  * Steps:
  * 1. Shorten long field names to their compact form equivalents.
  * 2. Sort the fields alphabetically for deterministic encoding.
  * 3. Stringify the object.
  * 4. Convert to hex.
  *
- * @param mptokenMetadata - MPTokenMetadata to encode.
- * @returns Hex encoded MPTokenMetadata.
+ * @param mptokenMetadata - {@link MPTokenMetadata} to encode.
+ * @returns Hex encoded {@link MPTokenMetadata}.
  * @throws Error if input is not a JSON object.
  * @category Utilities
  */
@@ -1091,7 +1091,7 @@ export function encodeMPTokenMetadata(
 
 /**
  * Expands compact field names to their long form equivalents.
- * Reverse operation of shortenKeys.
+ * Reverse operation of {@link shortenKeys}.
  *
  * @param input - Object with potentially compact field names.
  * @param mappings - Array of field mappings with long and compact names.
@@ -1129,11 +1129,11 @@ function expandKeys(
 }
 
 /**
- * Decodes hex encoded MPTokenMetadata to a JSON object with long field names.
- * Converts compact field names back to their long form equivalents.
+ * Decodes hex-encoded {@link MPTokenMetadata} into a JSON object.
+ * Converts compact field names to their corresponding long-form equivalents.
  *
- * @param input - Hex encoded MPTokenMetadata.
- * @returns Decoded MPTokenMetadata object with long field names.
+ * @param input - Hex encoded {@link MPTokenMetadata}.
+ * @returns Decoded {@link MPTokenMetadata} object with long field names.
  * @throws Error if input is not valid hex or cannot be parsed as JSON.
  * @category Utilities
  */
@@ -1187,10 +1187,10 @@ export function decodeMPTokenMetadata(input: string): MPTokenMetadata {
 }
 
 /**
- * Validates MPTokenMetadata adheres to XLS-89 standard.
+ * Validates {@link MPTokenMetadata} adheres to XLS-89 standard.
  *
- * @param input - Hex encoded MPTokenMetadata.
- * @returns Validation messages if MPTokenMetadata does not adheres to XLS-89 standard.
+ * @param input - Hex encoded {@link MPTokenMetadata}.
+ * @returns Validation messages if {@link MPTokenMetadata} does not adheres to XLS-89 standard.
  * @category Utilities
  */
 export function validateMPTokenMetadata(input: string): string[] {