webcomponents / webcomponents/webcomponents.org

document properties from getter @type

Open
#1,189 0 comments 0 reactions 0 assignees View on GitHub
Old Site
Dominant language
TypeScript
Stars
385
Forks
80
PR merge metrics
No merged PRs in 30d

Description

According to https://github.com/jsdoc3/jsdoc/issues/973, the right way to document getter/setter pairs is to document one of the two with a `@type`

It would be great if webcomponents.org would show types based on that comment.

Please see https://www.webcomponents.org/element/@power-elements/lazy-image/1.2.1/elements/lazy-image for an example of an element which documents getters that way. Property names and descriptions are shown, but types are shown as `?`

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.