Example Docs: Geometry

Classy! A reimplementation of the default JSDoc 3.6.x template, adding context-aware inferred ES6 class syntax doclet tags like static, alias, memberOf, and constructs for nested API classes.

Features

Inferred context for ES6 class members/methods.
Structured page navigation that matches nested ES6 API classes.
Table of contents for each page, automatically sourced from documentation contents.
Optionally link to git-hosted source files instead of generating extra source pages.
Automatically updates the API section of supplied README in generated index page.
Minimal external dependencies for generated documentation.
Native support for small viewport sizes.

Example Documentation

This site is an example of the style of documentation generated by Classy.

For actual details on how to use the template, see the Installation and Usage section of the README.

API

An example API entrypoint for a geometry package

Geometry.ExampleClass
- An example of a JavaScript class that is a member of the API entrypoint
Geometry.Interfaces
- Contains JavaScript classes that don't provide any proper implemented code
- An example of an ESModule treated as a member of the API entrypoint
Geometry.Shapes
- A collection of JavaScript classes that implement shapes on a grid
- An example of an ESModule treated as a member of the API entrypoint
Geometry.Utils
- Contains classes and methods useful for locating and drawing shapes on a grid
- An example of an ESModule treated as a member of the API entrypoint