Skip to content

Improve JSDoc #41

@JoseLion

Description

@JoseLion

As the API reference will be auto-generated with TypeDoc, we want to improve the JSDoc to add more information to the documentation. we want to add the following changes:

  • Add JSDoc to all assertion classes
  • Add @param to all generic types
  • Add @example to all assertion matcher methods to show their usage in the documentation
  • Change @link of built-in data types to link to the official JavaScript documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions