Skip to content

Commit

Permalink
remove html tag <br/> from comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Muhammad-Altabba committed Dec 5, 2023
1 parent 2adfb74 commit 1c55e4a
Show file tree
Hide file tree
Showing 10 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion packages/web3-eth-abi/src/eip_712.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/

/**
* The web3.eth.abi functions let you encode and decode parameters to ABI (Application Binary Interface) for function calls to the EVM (Ethereum Virtual Machine).<br/><br/>
* The web3.eth.abi functions let you encode and decode parameters to ABI (Application Binary Interface) for function calls to the EVM (Ethereum Virtual Machine).
*
* For using Web3 ABI functions, first install Web3 package using `npm i web3` or `yarn add web3`.
* After that, Web3 ABI functions will be available.
Expand Down
6 changes: 3 additions & 3 deletions packages/web3-eth-accounts/src/account.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/

/**
* The web3 accounts package contains functions to generate Ethereum accounts and sign transactions & data. <br/><br/>
* The web3 accounts package contains functions to generate Ethereum accounts and sign transactions & data.
*
* For using accounts functions, first install Web3 package using `npm i web3` or `yarn add web3` based on your package manager usage.
* After that, Accounts functions will be available as mentioned in following snippet.
Expand Down Expand Up @@ -99,7 +99,7 @@ import type {


/**
* Get the private key Uint8Array after the validation. <br/>
* Get the private key Uint8Array after the validation.
* Note: This function is not exported through main web3 package, so for using it directly import from accounts package.
* @param data - Private key
* @param ignoreLength - Optional, ignore length check during validation
Expand Down Expand Up @@ -140,7 +140,7 @@ export const parseAndValidatePrivateKey = (data: Bytes, ignoreLength?: boolean):

/**
*
* Hashes the given message. The data will be `UTF-8 HEX` decoded and enveloped as follows: <br/>
* Hashes the given message. The data will be `UTF-8 HEX` decoded and enveloped as follows:
* `"\\x19Ethereum Signed Message:\\n" + message.length + message` and hashed using keccak256.
*
* @param message - A message to hash, if its HEX it will be UTF8 decoded.
Expand Down
2 changes: 1 addition & 1 deletion packages/web3-eth-accounts/src/wallet.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ type BrowserError = { code: number; name: string };

/**
* Wallet is an in memory `wallet` that can hold multiple accounts.
* These accounts can be used when using web3.eth.sendTransaction() or web3.eth.contract.methods.contractfunction().send(); <br/>
* These accounts can be used when using web3.eth.sendTransaction() or web3.eth.contract.methods.contractfunction().send();
*
* For using Wallet functionality, install Web3 package using `npm i web3` or `yarn add web3`.
* After that, Wallet functionality will be available as mentioned below.
Expand Down
14 changes: 7 additions & 7 deletions packages/web3-eth-contract/src/contract.ts
Original file line number Diff line number Diff line change
Expand Up @@ -191,8 +191,8 @@ const contractSubscriptions = {
};

/**
* The `web3.eth.Contract` makes it easy to interact with smart contracts on the ethereum blockchain. <br/><br/>
* For using contract package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager, after that contracts features can be used as mentioned in following snippet.<br/>
* The `web3.eth.Contract` makes it easy to interact with smart contracts on the ethereum blockchain.
* For using contract package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager, after that contracts features can be used as mentioned in following snippet.
* ```ts
*
* import { Web3 } from 'web3';
Expand All @@ -203,7 +203,7 @@ const contractSubscriptions = {
* let contract = new web3.eth.Contract(abi,'0xdAC17F958D2ee523a2206206994597C13D831ec7');
* await contract.methods.balanceOf('0xdAC17F958D2ee523a2206206994597C13D831ec7').call();
* ```
* For using individual package install `web3-eth-contract` and `web3-core` packages using: `npm i web3-eth-contract web3-core` or `yarn add web3-eth-contract web3-core`. This is more efficient approach for building lightweight applications.<br/>
* For using individual package install `web3-eth-contract` and `web3-core` packages using: `npm i web3-eth-contract web3-core` or `yarn add web3-eth-contract web3-core`. This is more efficient approach for building lightweight applications.
* ```ts
*
* import { Web3Context } from 'web3-core';
Expand Down Expand Up @@ -259,7 +259,7 @@ const contractSubscriptions = {
* This will execute smart contract method in the EVM without sending any transaction. Note calling cannot alter the smart contract state.
*
* #### Parameters
* options?: PayableCallOptions | NonPayableCallOptions, <br/>
* options?: PayableCallOptions | NonPayableCallOptions,
* block?: BlockNumberOrTag,
*
* #### Returns
Expand All @@ -277,7 +277,7 @@ const contractSubscriptions = {
* Returns the amount of gas consumed by executing the method in EVM without creating a new transaction on the blockchain. The returned amount can be used as a gas estimate for executing the transaction publicly. The actual gas used can be different when sending the transaction later, as the state of the smart contract can be different at that time.
*
* #### Parameters
* options?: PayableCallOptions, <br/>
* options?: PayableCallOptions,
* returnFormat: ReturnFormat = DEFAULT_RETURN_FORMAT as ReturnFormat,
*
* #### Returns
Expand Down Expand Up @@ -308,10 +308,10 @@ const contractSubscriptions = {
*
* ### createAccessList
* This will create an access list a method execution will access when executed in the EVM.
* <br/> Note: You must specify a from address and gas if it’s not specified in options when instantiating parent contract object.
* Note: You must specify a from address and gas if it’s not specified in options when instantiating parent contract object.
*
* #### Parameters
* options?: PayableCallOptions | NonPayableCallOptions, <br/>
* options?: PayableCallOptions | NonPayableCallOptions,
* block?: BlockNumberOrTag,
*
* #### Returns
Expand Down
6 changes: 3 additions & 3 deletions packages/web3-eth-ens/src/ens.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ import { Registry } from './registry.js';
import { Resolver } from './resolver.js';

/**
* This class is designed to interact with the ENS system on the Ethereum blockchain. <br/><br/>
* For using ENS package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager, after that ENS features can be used as mentioned in following snippet.<br/>
* This class is designed to interact with the ENS system on the Ethereum blockchain.
* For using ENS package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager, after that ENS features can be used as mentioned in following snippet.
* ```ts
*
* import { Web3 } from 'web3';
Expand All @@ -43,7 +43,7 @@ import { Resolver } from './resolver.js';
*
* console.log(await web3.eth.ens.getAddress('ethereum.eth'))
* ```
* For using individual package install `web3-eth-ens` packages using: `npm i web3-eth-ens` or `yarn add web3-eth-ens`. This is more efficient approach for building lightweight applications.<br/>
* For using individual package install `web3-eth-ens` packages using: `npm i web3-eth-ens` or `yarn add web3-eth-ens`. This is more efficient approach for building lightweight applications.
*
* ```ts
*import { ENS } from 'web3-eth-ens';
Expand Down
6 changes: 3 additions & 3 deletions packages/web3-eth-iban/src/iban.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ import { InvalidAddressError } from 'web3-errors';
import { IbanOptions } from './types.js';

/**
* Converts Ethereum addresses to IBAN or BBAN addresses and vice versa.<br/><br/>
* For using Iban package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager, after that ENS features can be used.<br/>
* Converts Ethereum addresses to IBAN or BBAN addresses and vice versa.
* For using Iban package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager, after that ENS features can be used.
* ```ts
*
* import { Web3 } from 'web3';
Expand All @@ -33,7 +33,7 @@ import { IbanOptions } from './types.js';
* console.log(iban.checksum());
* ```
* For using individual package install `web3-eth-iban` packages using: `npm i web3-eth-iban` or `yarn add web3-eth-iban`.<br/>
* For using individual package install `web3-eth-iban` packages using: `npm i web3-eth-iban` or `yarn add web3-eth-iban`.
*
* ```ts
* import {Iban} from 'web3-eth-iban';
Expand Down
6 changes: 3 additions & 3 deletions packages/web3-eth-personal/src/personal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ import { Address, EthPersonalAPI, HexString, Transaction } from 'web3-types';
import * as rpcWrappers from './rpc_method_wrappers.js';

/**
* Eth Personal allows you to interact with the Ethereum node’s accounts.<br/><br/>
* For using Eth Personal package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager.<br/>
* Eth Personal allows you to interact with the Ethereum node’s accounts.
* For using Eth Personal package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager.
* ```ts
*
*import { Web3 } from 'web3';
Expand All @@ -31,7 +31,7 @@ import * as rpcWrappers from './rpc_method_wrappers.js';
* console.log(await web3.eth.personal.getAccounts());
*
* ```
* For using individual package install `web3-eth-personal` packages using: `npm i web3-eth-personal` or `yarn add web3-eth-personal`.<br/>
* For using individual package install `web3-eth-personal` packages using: `npm i web3-eth-personal` or `yarn add web3-eth-personal`.
*
* ```ts
* import {Personal} from 'web3-eth-personal';
Expand Down
2 changes: 1 addition & 1 deletion packages/web3-eth/src/web3_eth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ export const registeredSubscriptions = {

/**
*
* The Web3Eth allows you to interact with an Ethereum blockchain. <br/><br/>
* The Web3Eth allows you to interact with an Ethereum blockchain.
*
* For using Web3 Eth functions, first install Web3 package using `npm i web3` or `yarn add web3` based on your package manager usage.
* After that, Web3 Eth functions will be available as mentioned in following snippet.
Expand Down
6 changes: 3 additions & 3 deletions packages/web3-net/src/net.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ import { DataFormat, DEFAULT_RETURN_FORMAT, Web3NetAPI } from 'web3-types';
import * as rpcMethodsWrappers from './rpc_method_wrappers.js';

/**
* Net class allows you to interact with an Ethereum node’s network properties.<br/><br/>
* For using Net package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager, after that Net features can be used.<br/>
* Net class allows you to interact with an Ethereum node’s network properties.
* For using Net package, first install Web3 package using: `npm i web3` or `yarn add web3` based on your package manager, after that Net features can be used.
* ```ts
*
* import { Web3 } from 'web3';
Expand All @@ -30,7 +30,7 @@ import * as rpcMethodsWrappers from './rpc_method_wrappers.js';
* console.log(await web3.eth.net.getId());
*
* ```
* For using individual package install `web3-net` packages using: `npm i web3-net` or `yarn add web3-net`.<br/>
* For using individual package install `web3-net` packages using: `npm i web3-net` or `yarn add web3-net`.
*
* ```ts
* import {Net} from 'web3-net';
Expand Down
2 changes: 1 addition & 1 deletion packages/web3-utils/src/hash.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ along with web3.js. If not, see <http://www.gnu.org/licenses/>.
*/

/**
* This package provides utility functions for Ethereum dapps and other web3.js packages. <br/><br/>
* This package provides utility functions for Ethereum dapps and other web3.js packages.
*
* For using Utils functions, first install Web3 package using `npm i web3` or `yarn add web3`.
* After that, Web3 Utils functions will be available as mentioned below.
Expand Down

0 comments on commit 1c55e4a

Please sign in to comment.