fix: 🐛 PR fixes across the project

Author: Victor Wiebe

src/contract_wrappers/modules/checkpoint/dividend_checkpoint_wrapper.ts

@@ -513,12 +513,8 @@ export default abstract class DividendCheckpointWrapper extends ModuleWrapper {
 
   /**
    * Get static dividend data
-   * @return timestamp of dividends creation
-   * @return timestamp of dividends maturity
-   * @return timestamp of dividends expiry
-   * @return amount of dividends
-   * @return claimed amount of dividends
-   * @return name of dividends
+   * @return timestamp of dividends creation, timestamp of dividends maturity, timestamp of dividends expiry, amount
+   * of dividends, claimed amount of dividends, name of dividends
    */
   public getDividendsData = async () => {
     const result = await (await this.contract).getDividendsData.callAsync();
@@ -546,12 +542,8 @@ export default abstract class DividendCheckpointWrapper extends ModuleWrapper {
 
   /**
    * Get static dividend data
-   * @return timestamp of dividend creation
-   * @return timestamp of dividend maturity
-   * @return timestamp of dividend expiry
-   * @return amount of dividend
-   * @return claimed amount of dividend
-   * @return name of dividend
+   * @return timestamp of dividend creation, timestamp of dividend maturity, timestamp of dividend expiry, amount of
+   * dividend, claimed amount of dividend, name of dividend
    */
   public getDividendData = async (params: DividendIndexParams) => {
     const decimals = await (await this.securityTokenContract()).decimals.callAsync();
@@ -569,12 +561,8 @@ export default abstract class DividendCheckpointWrapper extends ModuleWrapper {
 
   /**
    * Retrieves list of investors, their claim status and whether they are excluded
-   * @return list of investors
-   * @return whether investor has claimed
-   * @return whether investor is excluded
-   * @return amount of withheld tax (estimate if not claimed)
-   * @return amount of claim (estimate if not claimeed)
-   * @return investor balance
+   * @return list of investors, whether investor has claimed, whether investor is excluded, amount of withheld tax
+   * (estimate if not claimed), amount of claim (estimate if not claimeed), investor balance
    */
   public getDividendProgress = async (params: DividendIndexParams) => {
     assert.assert(await this.isValidDividendIndex(params.dividendIndex), 'Invalid dividend index');
@@ -604,9 +592,7 @@ export default abstract class DividendCheckpointWrapper extends ModuleWrapper {
 
   /**
    * Retrieves list of investors, their balances, and their current withholding tax percentage
-   * @return list of investors
-   * @return investor balances
-   * @return investor withheld percentages
+   * @return list of investors, investor balances, investor withheld percentages
    */
   public getCheckpointData = async (params: CheckpointIdParams): Promise<CheckpointData[]> => {
     const currentCheckpointId = await (await this.securityTokenContract()).currentCheckpointId.callAsync();

src/contract_wrappers/modules/checkpoint/erc20_dividend_checkpoint_wrapper.ts

@@ -156,7 +156,7 @@ interface CreateDividendParams extends TxParams {
 }
 
 /**
- * @param _checkpointId Checkpoint id from which to create dividends
+ * @param checkpointId Checkpoint id from which to create dividends
  */
 interface CreateDividendWithCheckpointParams extends CreateDividendParams {
   checkpointId: number;

src/contract_wrappers/modules/permission_manager/general_permission_manager_wrapper.ts

@@ -219,8 +219,6 @@ export default class GeneralPermissionManagerWrapper extends ModuleWrapper {
 
   /**
    * Used to add a delegate
-   * @param delegate Ethereum address of the delegate
-   * @param details Details about the delegate i.e `Belongs to financial firm`
    */
   public addDelegate = async (params: AddDelegateParams) => {
     assert.assert(await this.isCallerAllowed(params.txData, Perm.Admin), 'Caller is not allowed');
@@ -306,8 +304,8 @@ export default class GeneralPermissionManagerWrapper extends ModuleWrapper {
 
   /**
    * Used to return all permission of a single or multiple module
-   * @return address[] the address array of Modules this delegate has permission
-   * @return bytes32[] the permission array of the corresponding Modules
+   * @return address[] the address array of Modules this delegate has permission, bytes32[]
+   * the permission array of the corresponding Modules
    */
   public getAllModulesAndPermsFromTypes = async (
     params: GetAllModulesAndPermsFromTypesParams,

src/contract_wrappers/modules/sto/capped_sto_wrapper.ts

@@ -301,15 +301,11 @@ export default class CappedSTOWrapper extends STOWrapper {
 
   /**
    * Return the STO details
-   * @return Date at which offering gets start.
-   * @return Date at which offering ends.
-   * @return Number of token base units this STO will be allowed to sell to investors.
-   * @return Token units a buyer gets as the rate
-   * @return Amount of funds raised
-   * @return Number of individual investors this STO have.
-   * @return Amount of tokens get sold.
-   * @return Boolean value to justify whether the fund raise type is POLY or not, i.e true for POLY.
-   * @return Boolean value to know the nature of the STO Whether it is pre-mint or mint on buying type sto.
+   * @return Date at which offering gets start., Date at which offering ends., Number of token base units this STO will
+   * be allowed to sell to investors., Token units a buyer gets as the rate, Amount of funds raised, Number of
+   * individual investors this STO have., Amount of tokens get sold., Boolean value to justify whether the fund raise
+   * type is POLY or not, i.e true for POLY., Boolean value to know the nature of the STO Whether it is pre-mint or
+   * mint on buying type sto.
    */
   public getSTODetails = async (): Promise<CappedSTODetails> => {
     const decimals = await (await this.securityTokenContract()).decimals.callAsync();

src/contract_wrappers/modules/sto/usd_tiered_sto_wrapper.ts

@@ -221,7 +221,7 @@ export namespace USDTieredSTOTransactionParams {
 }
 
 /**
- * tier Index of Tier
+ * @param tier Index of Tier
  */
 interface TierIndexParams {
   tier: number;
@@ -484,7 +484,7 @@ export default class USDTieredSTOWrapper extends STOWrapper {
   };
 
   /**
-   *  check if the module is paused
+   *  Check if the module is paused
    *  @return boolean if paused
    */
   public paused = async (): Promise<boolean> => {
@@ -734,15 +734,10 @@ export default class USDTieredSTOWrapper extends STOWrapper {
 
   /**
    * Return the STO details
-   * @return Unixtimestamp at which offering gets start.
-   * @return Unixtimestamp at which offering ends.
-   * @return Currently active tier
-   * @return Array of Number of tokens this STO will be allowed to sell at different tiers.
-   * @return Array rate at which tokens are sold at different tiers
-   * @return Amount of funds raised
-   * @return Number of individual investors this STO have.
-   * @return Amount of tokens sold.
-   * @return Array of booleans to show if funding is allowed in ETH, POLY, SC respectively
+   * @return Unixtimestamp at which offering gets start., Unixtimestamp at which offering ends., Currently active tier,
+   * Array of Number of tokens this STO will be allowed to sell at different tiers., Array rate at which tokens are
+   * sold at different tiers, Amount of funds raised, Number of individual investors this STO have., Amount of tokens
+   * sold., Array of booleans to show if funding is allowed in ETH, POLY, SC respectively
    */
   public getSTODetails = async (): Promise<USDTieredSTOData> => {
     const result = await (await this.contract).getSTODetails.callAsync();
@@ -840,12 +835,7 @@ export default class USDTieredSTOWrapper extends STOWrapper {
 
   /**
    * Return tiers
-   * @return rate
-   * @return rateDiscountPoly
-   * @return tokensTotal
-   * @return tokensDiscountPoly
-   * @return mintedTotal
-   * @return mintedDiscountPoly
+   * @return rate, rateDiscountPoly, tokensTotal, tokensDiscountPoly, mintedTotal, mintedDiscountPoly
    */
   public tiers = async (params: TierIndexParams): Promise<Tier> => {
     const decimals = await (await this.securityTokenContract()).decimals.callAsync();
@@ -1049,9 +1039,7 @@ export default class USDTieredSTOWrapper extends STOWrapper {
 
   /**
    * Returns investor accredited & non-accredited override information
-   * @return investor[]
-   * @return accredited data value
-   * @return nonAccreditedLimitUSDOverride value
+   * @return investor[], accredited data value, nonAccreditedLimitUSDOverride value
    */
   public getAccreditedData = async (): Promise<AccreditedData[]> => {
     const result = await (await this.contract).getAccreditedData.callAsync();