docs: added jsdocs

Author: ricmoo

src.ts/abi/fragments.ts

@@ -28,7 +28,7 @@ export { Typed } from "./typed.js";
 
 export type {
     JsonFragment, JsonFragmentType,
-    FormatType, FragmentType, FragmentWalkAsyncFunc, FragmentWalkFunc
+    FormatType, FragmentType, ParamTypeWalkAsyncFunc, ParamTypeWalkFunc
 } from "./fragments.js";
 
 export type {

src.ts/abi/index.ts

@@ -36,6 +36,10 @@ let __keccak256: (data: Uint8Array) => BytesLike = _keccak256;
  *    keccak256(new Uint8Array([ 0x13, 0x37 ]))
  *    //_result:
  *
+ *    // Strings are assumed to be DataHexString, otherwise it will
+ *    // throw. To hash UTF-8 data, see the note above.
+ *    keccak256("Hello World")
+ *    //_error:
  */
 export function keccak256(_data: BytesLike): string {
     const data = getBytes(_data, "data");

src.ts/crypto/keccak.ts

@@ -127,6 +127,7 @@ export {
 export type {
     JsonFragment, JsonFragmentType,
     InterfaceAbi,
+    ParamTypeWalkFunc, ParamTypeWalkAsyncFunc
 } from "./abi/index.js";
 
 export type { Addressable } from "./address/index.js";

src.ts/ethers.ts

@@ -2,7 +2,7 @@
  *  The Application Programming Interface (API) is the collection of
  *  functions, classes and types offered by the Ethers library.
  *
- *  @_section: api:API Specification  [about-api]
+ *  @_section: api:Application Programming Interface  [about-api]
  *  @_navTitle: API
  */
 import * as ethers from "./ethers.js";

src.ts/index.ts

@@ -1,5 +1,5 @@
 /**
- *  [Base64 encoding](link-base64) using 6-bit words to encode
+ *  [Base64 encoding](link-wiki-base64) using 6-bit words to encode
  *  arbitrary bytes into a string using 65 printable symbols, the
  *  upper-case and lower-case alphabet, the digits ``0`` through ``9``,
  *  ``"+"`` and ``"/"`` with the ``"="`` used for padding.

src.ts/utils/base64.ts

@@ -173,6 +173,12 @@ function zeroPad(data: BytesLike, length: number, left: boolean): string {
 /**
  *  Return the [[DataHexString]] of %%data%% padded on the **left**
  *  to %%length%% bytes.
+ *
+ *  If %%data%% already exceeds %%length%%, a [[BufferOverrun]] is
+ *  thrown.
+ *
+ *  This pads data the same as **values** are in Solidity
+ *  (e.g. ``uint128``).
  */
 export function zeroPadValue(data: BytesLike, length: number): string {
     return zeroPad(data, length, true);
@@ -181,6 +187,12 @@ export function zeroPadValue(data: BytesLike, length: number): string {
 /**
  *  Return the [[DataHexString]] of %%data%% padded on the **right**
  *  to %%length%% bytes.
+ *
+ *  If %%data%% already exceeds %%length%%, a [[BufferOverrun]] is
+ *  thrown.
+ *
+ *  This pads data the same as **bytes** are in Solidity
+ *  (e.g. ``bytes16``).
  */
 export function zeroPadBytes(data: BytesLike, length: number): string {
     return zeroPad(data, length, false);

src.ts/utils/data.ts

@@ -1,3 +1,8 @@
+/**
+ *  Explain UUID and link to RFC here.
+ *
+ *  @_subsection: api/utils:UUID  [about-uuid]
+ */
 import { getBytes, hexlify } from "./data.js";
 
 import type { BytesLike } from "./index.js";

src.ts/utils/uuid.ts

@@ -17,6 +17,8 @@ export class LangCz extends WordlistOwl {
      *
      *  Using the constructor should be unnecessary, instead use the
      *  [[wordlist]] singleton method.
+     *
+     *  @_ignore:
      */
     constructor() { super("cz", words, checksum); }
 

src.ts/wordlists/lang-cz.ts

@@ -17,6 +17,8 @@ export class LangEn extends WordlistOwl {
      *
      *  This should be unnecessary most of the time as the exported
      *  [[langEn]] should suffice.
+     *
+     *  @_ignore:
      */
     constructor() { super("en", words, checksum); }