maptalks.js icon indicating copy to clipboard operation
maptalks.js copied to clipboard

📃 docs(类型定义): 增加从jsdoc自动生成类型定义功能

Open aliothor opened this issue 2 years ago • 4 comments

目前仅修改部分jsdoc注释,用来修复部分类型定义错误问题,一部分类型定义缺失可能需要修改代码来兼容生成的类型定义

aliothor avatar Sep 10 '23 08:09 aliothor

Codecov Report

Merging #2082 (6c6736c) into master (c45d1cc) will increase coverage by 0.01%. The diff coverage is n/a.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

@@            Coverage Diff             @@
##           master    #2082      +/-   ##
==========================================
+ Coverage   83.67%   83.68%   +0.01%     
==========================================
  Files         167      167              
  Lines       18564    18564              
==========================================
+ Hits        15533    15535       +2     
+ Misses       3031     3029       -2     
Files Coverage Δ
src/control/Control.Attribution.js 91.30% <ø> (ø)
src/control/Control.Compass.js 80.76% <ø> (ø)
src/control/Control.LayerSwitcher.js 70.46% <ø> (ø)
src/control/Control.Overview.js 89.06% <ø> (ø)
src/control/Control.Panel.js 87.87% <ø> (ø)
src/control/Control.Reset.js 78.94% <ø> (ø)
src/control/Control.Scale.js 88.63% <ø> (ø)
src/control/Control.Toolbar.js 79.01% <ø> (ø)
src/control/Control.Zoom.js 91.11% <ø> (ø)
src/control/Control.js 95.00% <ø> (ø)
... and 35 more

... and 1 file with indirect coverage changes

:mega: Codecov offers a browser extension for seamless coverage viewing on GitHub. Try it in Chrome or Firefox today!

codecov-commenter avatar Sep 10 '23 08:09 codecov-commenter

哇,非常感谢!typings和api文档是用以下命令生成吧?

npm run build-typings
npm run build-api

我晚点找个时间验证一下,没问题我就会合并进来

fuzhenn avatar Sep 11 '23 05:09 fuzhenn

使用npm run build-typings会在typings目录下生成类型文件,使用npm run build-api会在api目录下载生成api文档,不过生成的api文档目前看来内容上会有一些缺失,我在研究一下

aliothor avatar Sep 11 '23 05:09 aliothor

好的,辛苦啦

fuzhenn avatar Sep 14 '23 03:09 fuzhenn