bitovi / bitovi/documentjs

All JSDocs tags that are supported by documentjs aren't documented

Open
#241 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
598
Forks
371
PR merge metrics
No merged PRs in 30d

Description

for example **constructor** (is in jsdoc, so it's okay...), **codestart** tags are parsed by documentjs but isn't documented. At the same time **extends** (although there is _inherit_ tag for it), **version** tags, for example, aren't understood by documentjs, but it isn't called out anywhere. I'm calling this out because the github readme of documentjs repo says

> Specify your code's behavior precisely with JSDoc and Google Closure Compiler annotations.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the documentation and the README claim about JSDoc and Google Closure Compiler annotations, then compare it with the tags documentjs parses. Check the examples mentioned—constructor, codestart, extends, and version—and document which tags are supported or unsupported; done means the documented behavior matches the parser.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.