o2web/jsdoc.conf.json · micoder/O2OA

代码拉取完成,页面将自动刷新

扫描微信二维码支付

取消

支付完成

richgiteeai

Watch

不关注关注所有动态仅关注版本发行动态关注但不提醒动态

1 Star 0 Fork 4K

micoder/O2OA

forked from 兰德网络O2OA平台软件/O2OA

代码 Issues 0 Pull Requests 0 Wiki 统计流水线

服务

加入 Gitee

与超过 1400万开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)

免费加入

已有帐号? 立即登录

文件

master

分支 (6)

标签 (42)

管理

master

wrdp

develop

release

dependabot/maven/o2server/org.quartz-scheduler-quartz-2.3.2

dependabot/npm_and_yarn/o2server/mixin-deep-1.3.2

6.0.2

6.0.1

6.0.0

5.4.1

wrdp-5.4.0

5.4.0

5.3.5

5.3.4

5.3.3

5.3.2

5.3.1

5.3.0

wrdp-5.3.0

wrdp-5.2.6

wrdp-5.2.5

wrdp-5.2.4

wrdp-5.2.3

5.2.5

wrdp-5.2

5.2.4

克隆/下载

HTTPS SSH SVN SVN+SSH 下载ZIP

提示

下载代码请复制以下命令到终端执行

为确保你提交的代码身份被 Gitee 正确识别,请执行以下命令完成配置

git config --global user.name userName 
git config --global user.email userEmail

初次使用 SSH 协议进行代码克隆、推送等操作时,需按下述提示完成 SSH 配置

1 生成 RSA 密钥

2 获取 RSA 公钥内容,并配置到 SSH公钥中

在 Gitee 上使用 SVN,请访问使用指南

使用 HTTPS 协议时,命令行会出现如下账号密码验证步骤。基于安全考虑,Gitee 建议配置并使用私人令牌替代登录密码进行克隆、推送等操作

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # 私人令牌

分支 6

标签 42

O2OA

o2web

jsdoc.conf.json

jsdoc.conf.json 2.60 KB

{
 "opts": { //命令行参数,在配置文件中配置了就不要敲命令了
 "encoding": "utf8", //文件编码utf8
 "destination": "./o2web/api/", //输出目标文件夹
 "recurse": true, //是否递归抽取sorce/include配置的文件夹
 "template" : "./node_modules/tidy-jsdoc-o2", //模板路径
 "prism-theme": "prism-custom", //模板中的代码块样式主题
 "readme" : "./o2web/jsdoc_static/home/README.md" //首页
 //"tutorials": "./o2web/tutorials" //如果有教程,对应教程目录
 },

"tags": {
 "allowUnknownTags": true, //允许jsdoc中未命名的标签
 "dictionaries": [ //标签库
 "jsdoc",
 "closure"
 ]
 },
 "source": {
 "include": [ //需要抽取文档的源文件夹,顺序和搜索结果的顺序有关
 "./o2web/source/o2_core/o2/xScript",
 "./o2web/source/x_desktop/js/o2m.api.js",
 "./o2web/source/x_component_process_Xform",
 "./o2web/source/x_component_cms_Xform"
 ],
 "includePattern": ".+\\.js(doc|x)?$", //抽取的源文件名称正则表达式
 "excludePattern": "(^|\\/|\\\\)_" //排除的源文件正则表达式
 },
 "plugins": [ //启用插件
 "plugins/markdown", //把markdown转成html
 "plugins/summarize" //为每个doclet生成摘要
 ],
 "templates": { //模板参数
 "cleverLinks": false, //@link标签是否呈现为纯文本
 "monospaceLinks": false,
 "default": {
 "staticFiles": { //静态文件目录
 "include": [
 "./o2web/jsdoc_static"
 ]
 }
 }
 },
 "metadata": {
 "title": "O2OA前台API", //最终生成的文档中标题
 "title_prefix" : "O2OA WebAPI", //html title标题前缀
 "title_suffix" : " | O2OA开发平台" //标题后缀
 },
 "o2" : {
 "actionOutPath" : "./o2server/{actionRoot}/src/main/webapp/describe/jsdoc/{actionName}.json",
 //"actionOutPath" : "./o2web/jsdoc/{actionRoot}/{actionName}.json",
 "actionOutExamplePath" : "./o2web/jsdoc_static/actionOut_examples/{actionRoot}.json"
 },
 "search" : {
 "enable" : true,
 "results_title" : " results matching ",
 "no_results_title" : "No results matching ''",
 "placeholder" : "输入关键字搜索"
 }
}
//执行命令: jsdoc -c ./o2web/jsdoc.conf.json -q version=v5.3.5

一键复制编辑原始数据按行查看历史

火羽白提交于 2021年02月25日 18:04 +08:00 . jsdoc

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

{
"opts":{//命令行参数,在配置文件中配置了就不要敲命令了
"encoding":"utf8",//文件编码utf8
"destination":"./o2web/api/",//输出目标文件夹
"recurse":true,//是否递归抽取sorce/include配置的文件夹
"template":"./node_modules/tidy-jsdoc-o2",//模板路径
"prism-theme":"prism-custom",//模板中的代码块样式主题
"readme":"./o2web/jsdoc_static/home/README.md"//首页
//"tutorials":"./o2web/tutorials"//如果有教程,对应教程目录
},

"tags":{
"allowUnknownTags":true,//允许jsdoc中未命名的标签
"dictionaries":[//标签库
"jsdoc",
"closure"
]
},
"source":{
"include":[//需要抽取文档的源文件夹,顺序和搜索结果的顺序有关
"./o2web/source/o2_core/o2/xScript",
"./o2web/source/x_desktop/js/o2m.api.js",
"./o2web/source/x_component_process_Xform",
"./o2web/source/x_component_cms_Xform"
],
"includePattern":".+\\.js(doc|x)?$",//抽取的源文件名称正则表达式
"excludePattern":"(^|\\/|\\\\)_"//排除的源文件正则表达式
},
"plugins":[//启用插件
"plugins/markdown",//把markdown转成html
"plugins/summarize"//为每个doclet生成摘要
],
"templates":{//模板参数
"cleverLinks":false,//@link标签是否呈现为纯文本
"monospaceLinks":false,
"default":{
"staticFiles":{//静态文件目录
"include":[
"./o2web/jsdoc_static"
]
}
}
},
"metadata":{
"title":"O2OA前台API",//最终生成的文档中标题
"title_prefix":"O2OA WebAPI",//htmltitle标题前缀
"title_suffix":" | O2OA开发平台"//标题后缀
},
"o2":{
"actionOutPath":"./o2server/{actionRoot}/src/main/webapp/describe/jsdoc/{actionName}.json",
//"actionOutPath":"./o2web/jsdoc/{actionRoot}/{actionName}.json",
"actionOutExamplePath":"./o2web/jsdoc_static/actionOut_examples/{actionRoot}.json"
},
"search":{
"enable":true,
"results_title":"<span class='search-results-count'></span> results matching <span class='search-query'></span>",
"no_results_title":"No results matching '<span class='search-query'></span>'",
"placeholder":"输入关键字搜索"
}
}
//执行命令:jsdoc-c./o2web/jsdoc.conf.json-qversion=v5.3.5