Skip to content

Document how each tag can affect a doclet #73

Open
@hegemonic

Description

@hegemonic

In the documentation for each tag, we need to briefly illustrate how that tag affects a doclet.

One pie-in-the-sky idea:

  1. Convert the code samples for each tag to external files, or extract them from the .md files at build time.
  2. Use JSDoc to create a doclet for each code sample (optional: both with and without the tag). We might want to filter out some properties that add more noise than signal.
  3. Allow users to toggle between the code sample and the generated doclet (optional: highlight any changes or additions, but not deletions, that occur when the tag is added).

Or we could just build the doclets in the browser, juuuuuuuuust as soon as I finish converting JSDoc to a standalone library. 😬😬😬😬

Splitting this out from #68 because it's a large, and mostly separate, chunk of work.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions