MartinP460 / react-denmark-map

Customizable plug-and-play map of Denmark for visual presentation🗺️
https://react-denmark-map.vercel.app/
MIT License
21 stars 4 forks source link

[V2] Add JSDoc comments to all props #36

Closed MartinP460 closed 9 months ago

MartinP460 commented 9 months ago

⚠️ Important: This issue is part of the version 2.0 release. Make sure to read the v2 contributing guidelines. Checkout from the v2 branch when creating the branch and open a PR towards this branch. ⚠️

Description

There are few JSDoc comments for any of the props. We would like to have JSDoc comments on all props such that users get much better Intellisense.

Proposed solution

In MapProps, add JSDoc comments for all props. The first line of the comment should be a summary of the prop. Further lines should describe the arguments if it's a function or React component (using @param). There should also been an @example part on the props where it makes sense.

Additional context

JSDoc documentation.