使用以下体系结构,如何使用jsduck记录覆盖文件夹中的类。
MyApp
-app
-overrides
-plugins
-resources
-...
似乎只能记录应用程序文件夹中的类。在我的jsduck文档中,仅显示文件夹"应用程序"和"Ext"
以及如何在文件夹中创建指向文件的链接覆盖。以下选项不起作用:
{@link overrides.file file}
{@link MyApp.overrides.file file}
编辑:
MyApp
-app
. panel
. panel.MyController.js
. onPrintButtonMethod (overrides.printPanel.js)
-overrides
. overrides.printPanel.js
-plugins
-resources
-...
我尝试了以下解决方案,但似乎没有在 jsduck 中记录对类"覆盖"的任何引用。打印面板'。记录此案例的最佳方法是什么?
/**
*@class myapp.panel.MyController
*@class overrides.PrintPanel
*
*@override myapp.panel.MyController
*@override Ext.panel.Panel
*/
Ext.define('overrides.PrintPanel', {
override: 'Ext.panel.Panel',
…
});
jsduck 中显示的文件夹和文件:
- MyApp
-app
- store
- ux
- view
- panel
-panel.MyController.js
- Ext
-Microloader
global
查看@override标签文档。
关于源文件的@link
,JSDuck不支持这些。虽然它们不应该真正需要 - 记录的方法/类/等将自动链接到源文件。如果你真的需要,你可以使用硬编码的Markdown或HTML链接。