jsdoc

o2web/jsdoc.conf.json

@@ -1,35 +1,38 @@
 {
-    "opts": {
-        "encoding": "utf8",               // same as -e utf8
-        "destination": "./o2web/jsdoc/",          // same as -d ./out/
-        "recurse": true,                 // same as -r
-        "template" : "./node_modules/tidy-jsdoc",
-        "prism-theme": "prism-custom"
-        //        "tutorials": "./o2web/tutorials" // same as -u path/to/tutorials
+    "opts": {    //命令行参数，在配置文件中配置了就不要敲命令了
+        "encoding": "utf8",               //文件编码utf8
+        "destination": "./o2web/jsdoc/",          //输出目标文件夹
+        "recurse": true,                 //是否递归抽取sorce/include配置的文件夹
+        "template" : "./node_modules/tidy-jsdoc-o2", //模板路径
+        "prism-theme": "prism-custom" //模板中的代码块样式主题
+        //"tutorials": "./o2web/tutorials" //如果有教程，对应教程目录
     },
 
     "tags": {
-        "allowUnknownTags": true,
-        "dictionaries": [
+        "allowUnknownTags": true, //允许jsdoc中未命名的标签
+        "dictionaries": [   //标签库
             "jsdoc",
             "closure"
         ]
     },
     "source": {
-        "include": ["./o2web/source/x_component_process_Xform","./o2web/source/o2_core/o2/xScript"],
-        "includePattern": ".+\\.js(doc|x)?$",
-        "excludePattern": "(^|\\/|\\\\)_"
+        "include": [ //需要抽取文档的源文件夹
+            "./o2web/source/x_component_process_Xform",
+            "./o2web/source/o2_core/o2/xScript"
+        ],
+        "includePattern": ".+\\.js(doc|x)?$", //抽取的源文件名称正则表达式
+        "excludePattern": "(^|\\/|\\\\)_" //排除的源文件正则表达式
     },
-    "plugins": [
-        "plugins/markdown",
-        "plugins/summarize"
+    "plugins": [ //启用插件
+        "plugins/markdown", //把markdown转成html
+        "plugins/summarize" //为每个doclet生成摘要
     ],
-    "templates": {
-        "cleverLinks": false,
+    "templates": {  //模板参数
+        "cleverLinks": false, //@link标签是否呈现为纯文本
         "monospaceLinks": false
     },
     "metadata": {
-        "title": "O2OA前台API"
+        "title": "O2OA前台API" //最终生成的文档中标题
     }
 }
 //执行命令: jsdoc -c ./o2web/jsdoc.conf.json

o2web/source/x_component_process_Xform/$Input.js

@@ -1,6 +1,7 @@
 MWF.xDesktop.requireApp("process.Xform", "$Module", null, false);
 /** @class $Input 组件类，此类为所有输入组件的父类
  * @hideconstructor
+ * @category FormComponents
 * @extends MWF.xApplication.process.Xform.$Module
  * @abstract
  */

o2web/source/x_component_process_Xform/$Module.js

@@ -1,6 +1,7 @@
 MWF.require("MWF.widget.Common", null, false);
 /** @classdesc $Module 组件类，此类为所有组件的父类。
  * @class
+ * @category FormComponents
  * @hideconstructor
  * */
 MWF.xApplication.process.Xform.$Module = MWF.APP$Module =  new Class(

o2web/source/x_component_process_Xform/Actionbar.js

@@ -10,6 +10,7 @@ MWF.xDesktop.requireApp("process.Xform", "$Module", null, false);
  * //方法2
  * var actionbar = this.target; //在操作条和操作本身的事件脚本中获取
  * @extends MWF.xApplication.process.Xform.$Module
+ * @category FormComponents
  * @hideconstructor
  */
 MWF.xApplication.process.Xform.Actionbar = MWF.APPActionbar =  new Class(

o2web/source/x_component_process_Xform/Address.js

@@ -8,6 +8,7 @@ MWF.xDesktop.requireApp("process.Xform", "Combox", null, false);
  * //方法2
  * var address = this.target; //组件本身的事件和脚本中获取
  * @extends MWF.xApplication.process.Xform.Combox
+ * @category FormComponents
  * @hideconstructor
  */
 MWF.xApplication.process.Xform.Address = MWF.APPAddress =  new Class(

o2web/source/x_component_process_Xform/Attachment.js

@@ -1076,6 +1076,7 @@ MWF.xApplication.process.Xform.AttachmentController = new Class({
  * //方法2
  * var attachment = this.target; //在组件事件脚本中获取
  * @extends MWF.xApplication.process.Xform.$Module
+ * @category FormComponents
  * @hideconstructor
  */
 MWF.xApplication.process.Xform.Attachment = MWF.APPAttachment = new Class(

o2web/source/x_component_process_Xform/Button.js

@@ -7,6 +7,7 @@ MWF.xDesktop.requireApp("process.Xform", "$Module", null, false);
  * //方法2
  * var attachment = this.target; //在组件事件脚本中获取
  * @extends MWF.xApplication.process.Xform.$Module
+ * @category FormComponents
  * @hideconstructor
  */
 MWF.xApplication.process.Xform.Button = MWF.APPButton =  new Class({

o2web/source/x_component_process_Xform/Calendar.js

@@ -7,6 +7,7 @@ MWF.xDesktop.requireApp("process.Xform", "$Input", null, false);
  * //方法2
  * var field = this.target; //在组件本身的脚本中获取，比如事件脚本、默认值脚本、校验脚本等等
  * @extends MWF.xApplication.process.Xform.$Input
+ * @category FormComponents
  * @hideconstructor
  */
 MWF.xApplication.process.Xform.Calendar = MWF.APPCalendar =  new Class(

o2web/source/x_component_process_Xform/Checkbox.js

@@ -8,6 +8,7 @@ MWF.require("MWF.widget.UUID", null, false);
  * //方法2
  * var field = this.target; //在组件本身的脚本中获取，比如事件脚本、默认值脚本、校验脚本等等
  * @extends MWF.xApplication.process.Xform.$Input
+ * @category FormComponents
  * @hideconstructor
  */
 MWF.xApplication.process.Xform.Checkbox = MWF.APPCheckbox =  new Class(

o2web/source/x_component_process_Xform/Combox.js

@@ -7,6 +7,7 @@ MWF.xDesktop.requireApp("process.Xform", "$Input", null, false);
  * //方法2
  * var field = this.target; //在组件本身的脚本中获取，比如事件脚本、默认值脚本、校验脚本等等
  * @extends MWF.xApplication.process.Xform.$Input
+ * @category FormComponents
  * @hideconstructor
  */
 MWF.xApplication.process.Xform.Combox = MWF.APPCombox =  new Class(

o2web/source/x_component_process_Xform/Common.js

@@ -7,6 +7,7 @@ MWF.xDesktop.requireApp("process.Xform", "$Module", null, false);
  * //方法2
  * var attachment = this.target; //在组件事件脚本中获取
  * @extends MWF.xApplication.process.Xform.$Module
+ * @category FormComponents
  * @hideconstructor
  */
 MWF.xApplication.process.Xform.Common = MWF.APPCommon =  new Class({

o2web/source/x_component_process_Xform/DatagridMobile.js

@@ -7,6 +7,7 @@ MWF.xDesktop.requireApp("process.Xform", "$Module", null, false);
  * //方法2
  * var attachment = this.target; //在组件事件脚本中获取
  * @extends MWF.xApplication.process.Xform.$Module
+ * @category FormComponents
  * @hideconstructor
  */
 MWF.xApplication.process.Xform.DatagridMobile = new Class(

o2web/source/x_component_process_Xform/DatagridPC.js

@@ -55,6 +55,7 @@ MWF.xDesktop.requireApp("process.Xform", "$Module", null, false);
  * //方法2
  * var attachment = this.target; //在组件事件脚本中获取
  * @extends MWF.xApplication.process.Xform.$Module
+ * @category FormComponents
  * @hideconstructor
  */
 MWF.xApplication.process.Xform.DatagridPC = new Class(

o2web/source/x_component_process_Xform/Div.js

@@ -7,6 +7,7 @@ MWF.xDesktop.requireApp("process.Xform", "$Module", null, false);
  * //方法2
  * var attachment = this.target; //在组件事件脚本中获取
  * @extends MWF.xApplication.process.Xform.$Module
+ * @category FormComponents
  * @hideconstructor
  */
 MWF.xApplication.process.Xform.Div = MWF.APPDiv =  new Class({

o2web/source/x_component_process_Xform/Documenteditor.js

@@ -7,6 +7,7 @@ MWF.xDesktop.requireApp("process.Xform", "$Module", null, false);
  * //方法2
  * var attachment = this.target; //在组件事件脚本中获取
  * @extends MWF.xApplication.process.Xform.$Module
+ * @category FormComponents
  * @hideconstructor
  */
 MWF.xApplication.process.Xform.Documenteditor = MWF.APPDocumenteditor =  new Class(

o2web/source/x_component_process_Xform/Form.js

@@ -6,6 +6,7 @@ MWF.xDesktop.requireApp("process.Xform", "lp." + MWF.language, null, false);
 //MWF.xDesktop.requireApp("process.Xform", "Package", null, false);
 
 /** @class Form 表单。
+ * @category FormComponents
  * @example
  * //可以在脚本中获取表单
  * //方法1：

o2web/source/x_component_process_Xform/Textfield.js

@@ -14,6 +14,7 @@ MWF.xDesktop.requireApp("process.Xform", "$Input", null, false);
  * var flag = field.isEmpty(); //字段是否为空
  * field.resetData();  //重置字段的值为默认值或置空
  * @extends MWF.xApplication.process.Xform.$Input
+ * @category FormComponents
  * @hideconstructor
  */
 MWF.xApplication.process.Xform.Textfield = MWF.APPTextfield =  new Class({

package.json

@@ -72,6 +72,7 @@
                 "progress-stream": "^2.0.0",
                 "request": "^2.88.2",
                 "single-line-log": "^1.1.2",
-                "targz": "^1.0.1"
+                "targz": "^1.0.1",
+                "tidy-jsdoc-o2": "0.0.1"
         }
 }