Example Docs 1.5.1

Namespace: Geometry.Interfaces

View Source on GitHub

Namespace: Geometry.Interfaces

Summary:
  • Contains JavaScript classes that don't provide any proper implemented code
  • An example of an ESModule treated as a member of the API entrypoint

These are a set of JavaScript classes that should be extended by other classes. They don't implement any actual functionality.

Note: Although they don't implement functionality, there's no technical reason they couldn't, since interfaces aren't really something JavaScript implements itself, and are a concept programmers try to use in JS for abstraction and organisation.

Usage

Kind:
singleton
Source:
example/src/interfaces/index.js, line 1

Interfaces

  • Geometry.Interfaces.Other
    • Describes a second interface documented in the same file as some other symbol
    • A JSDoc doclet that should be treated as an "interface"
  • Geometry.Interfaces.Shape
    • Describes a shape made up of a number of lines
    • A JavaScript class that should be treated as an "interface"