@webdoc/types

Type definitions for @webdoc/model

Usage no npm install needed!

<script type="module">
  import webdocTypes from 'https://cdn.skypack.dev/@webdoc/types';
</script>

README

@webdoc/types

This package contains all of the type definitions for docs (documentation blocks) and tags (@tag decorators in the documentation).

UML

https://drive.google.com/file/d/1SOo672UhTkF4H97kAWRVAFPEG3PIeEbi/view?usp=sharing

Overview

The are the core @webdoc/types Docs:

  • BaseDoc
  • ClassDoc
  • FunctionDoc
  • MethodDoc
  • EventDoc
  • TypedefDoc
  • PropertyDoc

These the core @webdoc/types Tags:

  • AccessTag
  • ParamTag
  • MemberTag
  • MethodTag

TODO: Finish this