Skip to content

Explain doclets better #68

Open
Open
@hegemonic

Description

@hegemonic

JSDoc uses the term "doclet" to refer to an object that represents the documentation for a JS symbol. It's important to know something about doclets if you're doing any of the following:

  • Creating or modifying a JSDoc template
  • Creating or modifying a JSDoc plugin
  • Using JSDoc to create a JSON file, then feeding the JSON file to another tool

We need a page that does all of the following:

  • Explains what a doclet is
  • Shows the typical properties in a doclet
  • Lists the non-enumerable properties in a doclet, and shows examples of each property
  • Points readers to the JSON schema for doclets

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions