parallax/jsPDF

General Documentation Improvements

Open

#2,931 创建于 2020年9月24日

在 GitHub 查看
 (3 评论) (0 反应) (1 负责人)JavaScript (4,596 fork)batch import
difficulty:mediumhacktoberfestpersistent

仓库指标

Star
 (28,280 star)
PR 合并指标
 (30 天内没有已合并 PR)

描述

The documentation of jsPDF is not very good. Many methods, classes, and parameters are badly documented or not at all.

  • Move all JSDoc comments to the typings file. This will improve the quality of the typings significantly, because IDEs can then display documentation inline. Change the jsdoc task so it uses the typings file instead of the source files (package.json script)
  • Review, fix, and update all documentation comments. Verify the behavior with the code. If there are questions, ask me ;)

贡献者指南