From 76ca46da6ef3301dc46f66278e6a5ca9ea6e6167 Mon Sep 17 00:00:00 2001 From: Bartek Nowotarski Date: Tue, 5 Jun 2018 14:08:36 +0200 Subject: [PATCH] Fix call builders jsdoc --- src/account_call_builder.js | 20 +++++++++++--------- src/assets_call_builder.js | 1 + src/effect_call_builder.js | 14 ++++++-------- src/ledger_call_builder.js | 19 ++++++++++--------- src/offer_call_builder.js | 5 ++++- src/operation_call_builder.js | 19 ++++++++++--------- src/path_call_builder.js | 1 + src/trade_aggregation_call_builder.js | 9 ++++++--- src/trades_call_builder.js | 5 ++++- src/transaction_call_builder.js | 19 ++++++++++--------- 10 files changed, 63 insertions(+), 49 deletions(-) diff --git a/src/account_call_builder.js b/src/account_call_builder.js index ba7ba11c4..4b5d09a96 100644 --- a/src/account_call_builder.js +++ b/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'); diff --git a/src/assets_call_builder.js b/src/assets_call_builder.js index d474a982f..d7e851e0f 100644 --- a/src/assets_call_builder.js +++ b/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. diff --git a/src/effect_call_builder.js b/src/effect_call_builder.js index 737b85117..1d7f7881f 100644 --- a/src/effect_call_builder.js +++ b/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'); diff --git a/src/ledger_call_builder.js b/src/ledger_call_builder.js index eb5f5aa87..caf472adb 100644 --- a/src/ledger_call_builder.js +++ b/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'); diff --git a/src/offer_call_builder.js b/src/offer_call_builder.js index 5fddd4e03..53e39369f 100644 --- a/src/offer_call_builder.js +++ b/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 diff --git a/src/operation_call_builder.js b/src/operation_call_builder.js index 2273c83d6..74df812f2 100644 --- a/src/operation_call_builder.js +++ b/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'); diff --git a/src/path_call_builder.js b/src/path_call_builder.js index 2e4323682..aae77f40e 100644 --- a/src/path_call_builder.js +++ b/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. diff --git a/src/trade_aggregation_call_builder.js b/src/trade_aggregation_call_builder.js index 6e84cfc76..8a18cd754 100644 --- a/src/trade_aggregation_call_builder.js +++ b/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 { } -} \ No newline at end of file +} diff --git a/src/trades_call_builder.js b/src/trades_call_builder.js index e135595d7..3238aca29 100644 --- a/src/trades_call_builder.js +++ b/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. */ diff --git a/src/transaction_call_builder.js b/src/transaction_call_builder.js index d6e2d6497..303a3d6dc 100644 --- a/src/transaction_call_builder.js +++ b/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');