jsdoc

o2web/source/o2_core/o2/xScript/CMSEnvironment.js

@@ -32,6 +32,35 @@ MWF.xScript.CMSEnvironment = function(ev){
     //this.inquiredRouteList = null;
 
     //workContext
+    /**
+     * DocumentControl 　内容管理的权限对象。
+     * @typedef {Object} DocumentControl
+     * @example
+     {
+        "allowRead": true,              //是否允许阅读文档
+        "allowPublishDocument": true,   //是否允许发布文档
+        "allowSave": true,              //是否允许保存文档
+        "allowPopularDocument": true,   //是否允许设置为热点
+        "allowEditDocument": true,      //是否允许编辑文档
+        "allowDeleteDocument": true     //是否允许删除文档
+    }
+     */
+    /**
+     * DocumentAttachmentData 　内容管理的权限对象。
+     * @typedef {Object} DocumentAttachmentData
+     * @example
+     {
+        "id": "a5cc5858-cac5-445a-a0a5-888d224eb2f6",   //附件ID
+        "site": "attachment",                           //附件存储位置（一般用于区分附件在哪个表单元素中显示）
+        "name": "13145352_115454884000_2.jpg",          //附件名称
+        "appId": "c295f34c-9ce1-4122-b795-820267e32b68",  //栏目ID
+        "categoryId": "33fb19f0-0670-464d-875c-32fb86148f7a",  //分类ID
+        "documentId": "ca74cbef-2a7f-401a-80e3-577ac9839348",  //文档ID
+        "creatorUid": "XX@huqi@P",                      //附件上传人
+        "extension": "jpg",
+        "length": 364507,                               //附件大小
+    }
+     */
     /**
      * 你可以通过documentContext获取内容管理实例相关的对象数据。
      * @module documentContext
@@ -49,7 +78,23 @@ MWF.xScript.CMSEnvironment = function(ev){
          * var doc = this.documentContext.getDocument();
          */
         "getDocument": function(){return ev.document },
+        /**
+         * 获取当前人对内容管理实例的权限。
+         * @method getControl
+         * @static
+         * @return {DocumentControl} 当前人对内容管理实例的所拥有的权限.
+         * @example
+         * var control = this.documentContext.getControl();
+         */
         "getControl": function(){return ev.control;},
+        /**
+         * 获取当前流程实例的附件对象列表。
+         * @method getAttachmentList
+         * @static
+         * @return {DocumentAttachment[]} 当前人对内容管理实例的所拥有的权限.
+         * @example
+         * var attachmentList = this.documentContext.getAttachmentList();
+         */
         "getAttachmentList": function(){return ev.attachmentList;}
         //"setTitle": function(title){
         //    if (!this.workAction){

o2web/source/x_component_process_Xform/Attachment.js

@@ -1036,8 +1036,8 @@ MWF.xApplication.process.Xform.AttachmentController = new Class({
 
 });
 /**
- * 附件数据结构.
- * @typedef {Object} AttachmentData
+ * 流程实例的附件数据结构.
+ * @typedef {Object} WorkAttachmentData
  * @property {String} id - 附件id.
  * @property {String} name - 附件标题.
  * @property {String} person - 上传人.
@@ -1720,7 +1720,7 @@ MWF.xApplication.process.Xform.Attachment = MWF.APPAttachment = new Class(
     },
     /**
      * @summary 为组件重新设置附件，该附件必须已经上传。
-     *  @param data{AttachmentData} .
+     *  @param data{WorkAttachmentData} .
      */
     setData: function(data){
         this.attachmentController.clear();