Merge pull request #175 from stellar/fix-jsdoc-call-builders

Fix call builders jsdoc

src/account_call_builder.js

@@ -1,15 +1,17 @@
 import {CallBuilder} from "./call_builder";
 
+/**
+ * Creates a new {@link AccountCallBuilder} pointed to server defined by serverUrl.
+ * Do not create this object directly, use {@link Server#accounts}.
+ *
+ * @see [All Accounts](https://www.stellar.org/developers/horizon/reference/accounts-all.html)
+ * @class AccountCallBuilder
+ * @extends CallBuilder
+ * @constructor
+ * @extends CallBuilder
+ * @param {string} serverUrl Horizon server URL.
+ */
 export class AccountCallBuilder extends CallBuilder {
-    /**
-     * Creates a new {@link AccountCallBuilder} pointed to server defined by serverUrl.
-     *
-     * Do not create this object directly, use {@link Server#accounts}.
-     * @see [All Accounts](https://www.stellar.org/developers/horizon/reference/accounts-all.html)
-     * @constructor
-     * @extends CallBuilder
-     * @param {string} serverUrl Horizon server URL.
-     */
     constructor(serverUrl) {
         super(serverUrl);
         this.url.segment('accounts');

src/assets_call_builder.js

@@ -4,6 +4,7 @@ import {CallBuilder} from "./call_builder";
  * Creates a new {@link AssetsCallBuilder} pointed to server defined by serverUrl.
  *
  * Do not create this object directly, use {@link Server#assets}.
+ * @class AssetsCallBuilder
  * @constructor
  * @extends CallBuilder
  * @param {string} serverUrl Horizon server URL.

src/effect_call_builder.js

@@ -1,18 +1,16 @@
 import {CallBuilder} from "./call_builder";
 
 /**
+ * Creates a new {@link EffectCallBuilder} pointed to server defined by serverUrl.
+ * Do not create this object directly, use {@link Server#effects}.
+ *
  * @class EffectCallBuilder
  * @extends CallBuilder
+ * @see [All Effects](https://www.stellar.org/developers/horizon/reference/effects-all.html)
+ * @constructor
+ * @param {string} serverUrl Horizon server URL.
  */
 export class EffectCallBuilder extends CallBuilder {
-    /*
-     * Creates a new {@link EffectCallBuilder} pointed to server defined by serverUrl.
-     *
-     * Do not create this object directly, use {@link Server#effects}.
-     * @see [All Effects](https://www.stellar.org/developers/horizon/reference/effects-all.html)
-     * @constructor
-     * @param {string} serverUrl Horizon server URL.
-     */
     constructor(serverUrl) {
         super(serverUrl);
         this.url.segment('effects');

src/ledger_call_builder.js

@@ -1,15 +1,16 @@
 import {CallBuilder} from "./call_builder";
 
+/**
+ * Creates a new {@link LedgerCallBuilder} pointed to server defined by serverUrl.
+ * Do not create this object directly, use {@link Server#ledgers}.
+ *
+ * @see [All Ledgers](https://www.stellar.org/developers/horizon/reference/ledgers-all.html)
+ * @constructor
+ * @class LedgerCallBuilder
+ * @extends CallBuilder
+ * @param {string} serverUrl Horizon server URL.
+ */
 export class LedgerCallBuilder extends CallBuilder {
-    /**
-     * Creates a new {@link LedgerCallBuilder} pointed to server defined by serverUrl.
-     *
-     * Do not create this object directly, use {@link Server#ledgers}.
-     * @see [All Ledgers](https://www.stellar.org/developers/horizon/reference/ledgers-all.html)
-     * @constructor
-     * @extends CallBuilder
-     * @param {string} serverUrl Horizon server URL.
-     */
     constructor(serverUrl) {
         super(serverUrl);
         this.url.segment('ledgers');

src/offer_call_builder.js

@@ -4,9 +4,12 @@ import {BadRequestError} from "./errors";
 
 /**
  * Creates a new {@link OfferCallBuilder} pointed to server defined by serverUrl.
- *
  * Do not create this object directly, use {@link Server#offers}.
+ *
  * @see [Offers for Account](https://www.stellar.org/developers/horizon/reference/offers-for-account.html)
+ * @class OfferCallBuilder
+ * @constructor
+ * @extends CallBuilder
  * @param {string} serverUrl Horizon server URL.
  * @param {string} resource Resource to query offers
  * @param {...string} resourceParams Parameters for selected resource

src/operation_call_builder.js

@@ -1,15 +1,16 @@
 import {CallBuilder} from "./call_builder";
 
+/**
+ * Creates a new {@link OperationCallBuilder} pointed to server defined by serverUrl.
+ * Do not create this object directly, use {@link Server#operations}.
+ *
+ * @see [All Operations](https://www.stellar.org/developers/horizon/reference/operations-all.html)
+ * @class OperationCallBuilder
+ * @constructor
+ * @extends CallBuilder
+ * @param {string} serverUrl Horizon server URL.
+ */
 export class OperationCallBuilder extends CallBuilder {
-    /**
-     * Creates a new {@link OperationCallBuilder} pointed to server defined by serverUrl.
-     *
-     * Do not create this object directly, use {@link Server#operations}.
-     * @see [All Operations](https://www.stellar.org/developers/horizon/reference/operations-all.html)
-     * @constructor
-     * @extends CallBuilder
-     * @param {string} serverUrl Horizon server URL.
-     */
     constructor(serverUrl) {
         super(serverUrl);
         this.url.segment('operations');

src/path_call_builder.js

@@ -17,6 +17,7 @@ import {CallBuilder} from './call_builder';
  *
  * Do not create this object directly, use {@link Server#paths}.
  * @see [Find Payment Paths](https://www.stellar.org/developers/horizon/reference/path-finding.html)
+ * @extends CallBuilder
  * @param {string} serverUrl Horizon server URL.
  * @param {string} source The sender's account ID. Any returned path must use a source that the sender can hold.
  * @param {string} destination The destination account ID that any returned path should use.

src/trade_aggregation_call_builder.js

@@ -4,15 +4,18 @@ import { NotFoundError, NetworkError, BadRequestError } from "./errors";
 const allowedResolutions = [60000, 300000, 900000, 3600000, 86400000, 604800000];
 
 /**
- * Trade Aggregations facilitate efficient gathering of historical trade data
+ * Trade Aggregations facilitate efficient gathering of historical trade data.
  * Do not create this object directly, use {@link Server#tradeAggregation}.
+ *
+ * @class TradeAggregationCallBuilder
+ * @extends CallBuilder
+ * @constructor
  * @param {string} serverUrl serverUrl Horizon server URL.
  * @param {Asset} base base asset
  * @param {Asset} counter counter asset
  * @param {long} start_time lower time boundary represented as millis since epoch
  * @param {long} end_time upper time boundary represented as millis since epoch
  * @param {long} resolution segment duration as millis since epoch. *Supported values are 1 minute (60000), 5 minutes (300000), 15 minutes (900000), 1 hour (3600000), 1 day (86400000) and 1 week (604800000).
- * @returns {OrderbookCallBuilder}
  */
 export class TradeAggregationCallBuilder extends CallBuilder {
   constructor (serverUrl, base, counter, start_time, end_time, resolution){
@@ -65,4 +68,4 @@ export class TradeAggregationCallBuilder extends CallBuilder {
   }
 
 
-}
+}

src/trades_call_builder.js

@@ -2,8 +2,11 @@ import {CallBuilder} from "./call_builder";
 
 /**
  * Creates a new {@link TradesCallBuilder} pointed to server defined by serverUrl.
- *
  * Do not create this object directly, use {@link Server#trades}.
+ *
+ * @class TradesCallBuilder
+ * @extends CallBuilder
+ * @constructor
  * @see [Trades](https://www.stellar.org/developers/horizon/reference/endpoints/trades.html)
  * @param {string} serverUrl serverUrl Horizon server URL.
  */

src/transaction_call_builder.js

@@ -1,15 +1,16 @@
 import {CallBuilder} from "./call_builder";
 
+/**
+ * Creates a new {@link TransactionCallBuilder} pointed to server defined by serverUrl.
+ * Do not create this object directly, use {@link Server#transactions}.
+ *
+ * @class TransactionCallBuilder
+ * @extends CallBuilder
+ * @see [All Transactions](https://www.stellar.org/developers/horizon/reference/transactions-all.html)
+ * @constructor
+ * @param {string} serverUrl Horizon server URL.
+ */
 export class TransactionCallBuilder extends CallBuilder {
-    /**
-     * Creates a new {@link TransactionCallBuilder} pointed to server defined by serverUrl.
-     *
-     * Do not create this object directly, use {@link Server#transactions}.
-     * @see [All Transactions](https://www.stellar.org/developers/horizon/reference/transactions-all.html)
-     * @constructor
-     * @extends CallBuilder
-     * @param {string} serverUrl Horizon server URL.
-     */
     constructor(serverUrl) {
         super(serverUrl);
         this.url.segment('transactions');