Misc. jsdoc fixups

stellar · Nov 20, 2023 · 6e4377e · 6e4377e
1 parent 85c9f91
commit 6e4377e
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 15 deletions.
diff --git a/src/numbers/xdr_large_int.js b/src/numbers/xdr_large_int.js
@@ -22,14 +22,10 @@ import xdr from '../xdr';
  *    integer-like values interpreted in big-endian order
  */
 export class XdrLargeInt {
-  /**
-   * @type {xdr.LargeInt}
-   */
+  /** @type {xdr.LargeInt} */
   int; // child class of a jsXdr.LargeInt
 
-  /**
-   * @type {string}   one of 'i64', 'u64', 'i128', 'u128', 'i256', or 'u256'
-   */
+  /** @type {string} */
   type;
 
   constructor(type, values) {

diff --git a/src/soroban.js b/src/soroban.js
@@ -1,4 +1,4 @@
-/** Soroban helper class to assist with formatting and parsing token amounts. */
+/* Helper class to assist with formatting and parsing token amounts. */
 export class Soroban {
   /**
    * Given a whole number smart contract amount of a token and an amount of

diff --git a/src/transaction.js b/src/transaction.js
@@ -154,8 +154,9 @@ export class Transaction extends TransactionBase {
   }
 
   /**
-   * @type {string} 64 bit account sequence
+   * 64 bit account sequence
    * @readonly
+   * @type {string}
    */
   get minAccountSequence() {
     return this._minAccountSequence;
@@ -165,7 +166,8 @@ export class Transaction extends TransactionBase {
   }
 
   /**
-   * @type {number} 64 bit number of seconds
+   * 64 bit number of seconds
+   * @type {number}
    * @readonly
    */
   get minAccountSequenceAge() {
@@ -176,7 +178,8 @@ export class Transaction extends TransactionBase {
   }
 
   /**
-   * @type {number} 32 bit number of ledgers
+   * 32 bit number of ledgers
+   * @type {number}
    * @readonly
    */
   get minAccountSequenceLedgerGap() {
@@ -187,7 +190,8 @@ export class Transaction extends TransactionBase {
   }
 
   /**
-   * @type {string[]}   array of extra signers (@{link StrKey}s)
+   * array of extra signers ({@link StrKey}s)
+   * @type {string[]}
    * @readonly
    */
   get extraSigners() {
@@ -204,7 +208,6 @@ export class Transaction extends TransactionBase {
   get sequence() {
     return this._sequence;
   }
-
   set sequence(value) {
     throw new Error('Transaction is immutable');
   }
@@ -216,7 +219,6 @@ export class Transaction extends TransactionBase {
   get source() {
     return this._source;
   }
-
   set source(value) {
     throw new Error('Transaction is immutable');
   }
@@ -228,7 +230,6 @@ export class Transaction extends TransactionBase {
   get operations() {
     return this._operations;
   }
-
   set operations(value) {
     throw new Error('Transaction is immutable');
   }
@@ -240,7 +241,6 @@ export class Transaction extends TransactionBase {
   get memo() {
     return Memo.fromXDRObject(this._memo);
   }
-
   set memo(value) {
     throw new Error('Transaction is immutable');
   }