Improve JSDoc #41
Description
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
@paramto all generic types - Add
@exampleto all assertion matcher methods to show their usage in the documentation - Change
@linkof built-in data types to link to the official JavaScript documentation.- For instance,
{@link Error}should point to the MDN Error docs
- For instance,