Support just jsdoc tags without method descriptions
Open
enhancement
- Dominant language
- JavaScript
- Stars
- 28
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Let the examples speak for themselves
``` js
/** @method add */
function add(a, b) { return a + b; }
/** @sample add */
it('adds numbers', function () {
lazyAss(add(2, 3) === 5);
lazyAss(add(2, -3) === -1);
});
```
Right now we require at least single method description to generate doc
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating the code that requires a method description before generating documentation, then find any tests or examples covering @method and @sample tags. Done means the shown JavaScript example generates documentation without a method description.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100