wanjia9506
/
amWiki
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

修改一批注释

This commit is contained in:
Tevin.li 2017-07-06 22:41:41 +08:00
parent 54e004d3a5
commit 213884bcc1
25 changed files with 228 additions and 200 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
bin/messageBox.js
View File

@ -15,7 +15,7 @@
/**
* 模拟消息框
* @param msg
* @param {String} msg
*/
const alert = (msg) => {
msg = typeof msg !== 'string' ? String(msg) : msg;
@ -24,8 +24,8 @@ const alert = (msg) => {
/**
* 模拟确认框，回调传参为用户选择的布尔值
* @param msg
* @returns {promise}
* @param {String} msg
* @returns {Promise}
*/
const confirm2 = (msg) => {
return new Promise((resolve, reject) => {
@ -52,8 +52,8 @@ const confirm2 = (msg) => {
/**
* 模拟输入框，回调传参为用户输入的字符串
* @param msg
* @returns {promise}
* @param {String} msg
* @returns {Promise}
*/
const prompt2 = (msg) => {
return new Promise((resolve, reject) => {

2
bin/printf.js
View File

@ -120,7 +120,7 @@ const printf = (function () {
},
/**
* 显示版本信息
* @param mainPath
* @param {String} mainPath
* @public
*/
ver: function (mainPath) {

24
build/creator.js
View File

@ -12,8 +12,8 @@ const creator = (function () {
return {
/**
* 复制文件
* @param {string} from
* @param {string} to
* @param {String} from
* @param {String} to
* @private
*/
_copyWikiFile: function (from, to) {
@ -23,8 +23,8 @@ const creator = (function () {
},
/**
* 创建 amWiki 必要的文件夹
* @param {string} outputPath
* @returns {boolean}
* @param {String} outputPath
* @returns {Boolean}
* @private
*/
_createWikiFolder: function (outputPath) {
@ -58,8 +58,8 @@ const creator = (function () {
/**
* 创建着色色系
* (ps: 颜色变亮变暗不是 rgb 分别同时增加或减少一个值)
* @param {string} color
* @returns {{base: string, light: string, dark: string}} - 生成的浅、中、深三色
* @param {String} color
* @returns {{base: String, light: String, dark: String}} - 生成的浅、中、深三色
* @private
*/
_clacWikiColour: function (color) {
@ -150,9 +150,9 @@ const creator = (function () {
},
/**
* 配置检查
* @param {string} configPath
* @param {string} filesPath
* @returns {promise}
* @param {String} configPath
* @param {String} filesPath
* @returns {Promise}
* @private
*/
_checkConfig: function (configPath, filesPath) {
@ -202,9 +202,9 @@ const creator = (function () {
},
/**
* 创建amWiki本地文件
* @param {string} configPath - config.json文件的路径
* @param {string} filesPath - 项目包files文件夹路径
* @returns {promise} 传参：项目根目录
* @param {String} configPath - config.json文件的路径
* @param {String} filesPath - 项目包files文件夹路径
* @returns {Promise} 项目根目录
* @public
*/
create: function (configPath, filesPath) {

62
build/exportGithub.js
View File

@ -11,8 +11,8 @@ const exportGithub = (function () {
return {
/**
* 拷贝一张图片
* @param {string} from
* @param {string} to
* @param {String} from
* @param {String} to
* @private
*/
_copyImg: function (from, to) {
@ -20,8 +20,8 @@ const exportGithub = (function () {
},
/**
* 拷贝一篇文档
* @param {string} fileName
* @param {string} pathTo
* @param {String} fileName
* @param {String} pathTo
* @private
*/
_copyMd: function (fileName, pathTo) {
@ -44,10 +44,10 @@ const exportGithub = (function () {
},
/**
* 导出导航、底部签名
* @param {[array]} fileList
* @param {[array]} duplicate
* @param {string} pathFrom
* @param {string} pathTo
* @param {[Array]} fileList
* @param {[Array]} duplicate
* @param {String} pathFrom
* @param {String} pathTo
* @private
*/
_exportNavigation: function (fileList, duplicate, pathFrom, pathTo) {
@ -73,8 +73,8 @@ const exportGithub = (function () {
},
/**
* 导出首页
* @param {string} pathFrom
* @param {string} pathTo
* @param {String} pathFrom
* @param {String} pathTo
* @private
*/
_exportHome: function (pathFrom, pathTo) {
@ -94,8 +94,8 @@ const exportGithub = (function () {
},
/**
* 导出图片
* @param {string} pathFrom
* @param {string} pathTo
* @param {String} pathFrom
* @param {String} pathTo
* @private
*/
_exportImage: function (pathFrom, pathTo) {
@ -123,8 +123,8 @@ const exportGithub = (function () {
},
/**
* 检查重名
* @param {[array]} fileList
* @returns {[array]}
* @param {[Array]} fileList
* @returns {[Array]}
* @private
*/
_checkDuplicate: function (fileList) {
@ -140,8 +140,8 @@ const exportGithub = (function () {
},
/**
* 导出重复文档
* @param {array} list
* @param {string} pathTo
* @param {Array} list
* @param {String} pathTo
* @private
*/
_exportDuplicate: function (list, pathTo) {
@ -165,8 +165,8 @@ const exportGithub = (function () {
},
/**
* 导出普通文档
* @param {array} list
* @param {string} pathTo
* @param {Array} list
* @param {String} pathTo
* @private
*/
_exportNormal: function (list, pathTo) {
@ -179,11 +179,11 @@ const exportGithub = (function () {
},
/**
* 开始导出
* @param {string} pathFrom
* @param {string} pathTo
* @param {[array]} fileList
* @param {[array]} duplicates
* @returns {promise}
* @param {String} pathFrom
* @param {String} pathTo
* @param {[Array]} fileList
* @param {[Array]} duplicates
* @returns {Promise}
* @private
*/
_toExport: function (pathFrom, pathTo, fileList, duplicates) {
@ -223,9 +223,9 @@ const exportGithub = (function () {
},
/**
* 导出准备
* @param {string} pathFrom
* @param {string} pathTo
* @returns {promise}
* @param {String} pathFrom
* @param {String} pathTo
* @returns {Promise}
* @private
*/
_toPrepare: function (pathFrom, pathTo) {
@ -277,8 +277,8 @@ const exportGithub = (function () {
_githubUrl: '',
/**
* 解析 GitHub url
* @param {string} path
* @returns {boolean|string}
* @param {String} path
* @returns {Boolean|String}
* @private
*/
_parseGithubUrl: function (path) {
@ -301,9 +301,9 @@ const exportGithub = (function () {
},
/**
* 导出为github-wiki
* @param {string} root - 文库项目根目录
* @param {string} outputPath - 输出路径
* @returns {promise}
* @param {String} root - 文库项目根目录
* @param {String} outputPath - 输出路径
* @returns {Promise}
* @public
*/
export: function (root, outputPath) {

10
build/localServer.js
View File

@ -18,8 +18,8 @@ const localServer = (function () {
_server: null,
/**
* 启动服务器
* @param {object} wikis - 文库记录列表的引用
* @param {number} port - 服务器端口号
* @param {Object} wikis - 文库记录列表的引用
* @param {Number} port - 服务器端口号
* @public
*/
run: function (wikis, port) {
@ -33,9 +33,9 @@ const localServer = (function () {
},
/**
* 浏览当前文档
* @param {string} editPath - 当前文档的路径
* @param {object} wikis - 文库记录列表的引用
* @returns {promise}
* @param {String} editPath - 当前文档的路径
* @param {Object} wikis - 文库记录列表的引用
* @returns {Promise}
* @public
*/
browser: function (editPath, wikis) {

30
build/makeMounts.js
View File

@ -12,8 +12,8 @@ const makeMounts = (function () {
return {
/**
* 创建 mounts 数据
* @param {string} editPath
* @param {boolean} [offMsg] - 是否关闭提示
* @param {String} editPath
* @param {Boolean} [offMsg] - 是否关闭提示
* @public
*/
make: function (editPath, offMsg) {
@ -32,8 +32,8 @@ const makeMounts = (function () {
},
/**
* 检查 mounts 创建许可
* @param rootPath
* @returns {boolean}
* @param {String} rootPath
* @returns {Boolean}
* @private
*/
_checkMountsAllow: function (rootPath) {
@ -50,10 +50,10 @@ const makeMounts = (function () {
},
/**
* 收集 mounts 数据
* @param {string} libPath
* @param {string} rootPath
* @param {[object]} list
* @returns {{array}}
* @param {String} libPath
* @param {String} rootPath
* @param {[Object]} list
* @returns {{Array}}
* @private
*/
_getMountsData: function (libPath, rootPath, list) {
@ -107,7 +107,7 @@ const makeMounts = (function () {
/**
* 获取导航挂载数据
* @param {String} libPath
* @returns {{name: string, path: string, content: String}}
* @returns {{name: String, path: String, content: String}}
* @private
*/
_getNavMount: function (libPath) {
@ -121,7 +121,7 @@ const makeMounts = (function () {
/**
* 获取图标挂载数据
* @param {String} rootPath
* @returns {{name: string, path: string, content: String}}
* @returns {{name: String, path: String, content: String}}
* @private
*/
_getIconsMount: function (rootPath) {
@ -134,9 +134,9 @@ const makeMounts = (function () {
},
/**
* 输出 ./mounts/*.js 文件
* @param {{array}} mountData
* @param {string} rootPath
* @returns {array}
* @param {{Array}} mountData
* @param {String} rootPath
* @returns {Array}
* @private
*/
_exportMounts: function (mountData, rootPath) {
@ -164,8 +164,8 @@ const makeMounts = (function () {
},
/**
* 更新 index.html 文件的挂载
* @param {array} mountFiles
* @param {string} rootPath
* @param {Array} mountFiles
* @param {String} rootPath
* @private
*/
_updateMountLinks: function (mountFiles, rootPath) {

28
build/makeNavigation.js
View File

@ -10,8 +10,8 @@ const makeNavigation = (function () {
return {
/**
* 刷新导航
* @param {string} editPath - 当前文档的路径
* @returns {string} library文件夹路径
* @param {String} editPath - 当前文档的路径
* @returns {String} library文件夹路径
* @public
*/
refresh: function (editPath) {
@ -25,9 +25,9 @@ const makeNavigation = (function () {
},
/**
* 创建 .md 导航文件
* @param {string} path - 文库library文件夹路径
* @param {object} tree - 目录结构树形数据
* @param {array} list - 目录结构列表数据
* @param {String} path - 文库library文件夹路径
* @param {Object} tree - 目录结构树形数据
* @param {Array} list - 目录结构列表数据
* @public
*/
make: function (path, tree, list) {
@ -98,9 +98,9 @@ const makeNavigation = (function () {
},
/**
* 检查id合法性
* @param {string} name
* @param {string} path
* @returns {boolean}
* @param {String} name
* @param {String} path
* @returns {Boolean}
* @private
*/
_checkFileId: function (name, path) {
@ -116,9 +116,9 @@ const makeNavigation = (function () {
},
/**
* 检查名称合法性
* @param {string} name
* @param {string} path
* @returns {boolean}
* @param {String} name
* @param {String} path
* @returns {Boolean}
* @private
*/
_checkFileName: function (name, path) {
@ -134,9 +134,9 @@ const makeNavigation = (function () {
},
/**
* 递归检查(某一目录下的同级文件和文件夹的)ID是否存在重复
* @param {object} tree - 当前层级的目录结构
* @param {string} path - 当前目录所在路径
* @return {boolean} 如果返回为true，则说明存在重复ID
* @param {Object} tree - 当前层级的目录结构
* @param {String} path - 当前目录所在路径
* @return {Boolean} 如果返回为true，则说明存在重复ID
* @private
*/
_checkDuplicateId: function (tree, path = '') {

46
build/manageFolder.js
View File

@ -9,12 +9,12 @@ const manageFolder = (function () {
return {
/**
* 递归分析指定文件夹下的目录结构
* @param {string} dirPath - 指定要分析的目录
* @param {number} [depth=0] - 文件夹深度
* @param {object} [tree={}] - 当前深度结构的树形
* @param {[object]} [list=[]] - 当前深度结构的列表
* @param {[string]} [files=[]] - 当前深度文件的列表
* @returns {{tree: object, list: array, files: array}} - 树形数据、列表数据、仅文件列表数据
* @param {String} dirPath - 指定要分析的目录
* @param {Number} [depth=0] - 文件夹深度
* @param {Object} [tree={}] - 当前深度结构的树形
* @param {[Object]} [list=[]] - 当前深度结构的列表
* @param {[String]} [files=[]] - 当前深度文件的列表
* @returns {{tree: Object, list: [Object], files: [String]}} - 树形数据、列表数据、仅文件列表数据
* @private
*/
_listSubFolder: function (dirPath, depth = 0, tree = {}, list = [], files = []) {
@ -68,8 +68,8 @@ const manageFolder = (function () {
},
/**
* 读取文库library文件夹树形数据
* @param {string} path - 文库library文件夹路径
* @returns {{tree: object, list: array, files: array}} - 树形数据、列表数据、仅文件列表数据
* @param {String} path - 文库library文件夹路径
* @returns {{tree: Object, list: [Object], files: [String]}} - 树形数据、列表数据、仅文件列表数据
* @public
*/
readLibraryTree: function (path) {
@ -88,7 +88,7 @@ const manageFolder = (function () {
},
/**
* 递归清空文件夹
* @param {string} path - 要清空的文件夹
* @param {String} path - 要清空的文件夹
* @public
*/
cleanFolder: function (path) {
@ -108,7 +108,7 @@ const manageFolder = (function () {
},
/**
* 递归创建文件夹
* @param {string} path - 需要创建的文件夹路径
* @param {String} path - 需要创建的文件夹路径
* @public
*/
createFolder: function (path) {
@ -127,8 +127,8 @@ const manageFolder = (function () {
},
/**
* 获取项目文件夹
* @param {string} path - 需要计算的文件夹路径
* @return {string|boolean} 放回当前文库项目的路径，如果非文库返回 false
* @param {String} path - 需要计算的文件夹路径
* @return {String|Boolean} 放回当前文库项目的路径，如果非文库返回 false
* @public
*/
getProjectFolder: function (path) {
@ -141,8 +141,8 @@ const manageFolder = (function () {
},
/**
* 获取 library 目录路径 (通过反向查找，而不是 split 截断)
* @param {string} path - 需要计算的文件夹路径
* @returns {string|boolean} 返回当前文库 library 目录的路径，如果非文库则返回 false
* @param {String} path - 需要计算的文件夹路径
* @returns {String|Boolean} 返回当前文库 library 目录的路径，如果非文库则返回 false
* @public
*/
getLibraryFolder: function (path) {
@ -171,8 +171,8 @@ const manageFolder = (function () {
},
/**
* 获取当前文件(夹)所属上级目录的路径
* @param {string} path - 需要计算的文件夹路径
* @returns {string|boolean} 父级文件夹路径
* @param {String} path - 需要计算的文件夹路径
* @returns {String|Boolean} 父级文件夹路径
* @public
*/
getParentFolder: function (path) {
@ -189,8 +189,8 @@ const manageFolder = (function () {
},
/**
* 获取当前文件(夹)的名称
* @param {string} path - 需要计算的路径
* @return {string} 文件(夹)名称
* @param {String} path - 需要计算的路径
* @return {String} 文件(夹)名称
* @public
*/
getBaseName: function (path) {
@ -198,9 +198,9 @@ const manageFolder = (function () {
},
/**
* 获取路径对应的一级目录 id
* @param {string} path
* @param {string} [libPath]
* @returns {string}
* @param {String} path
* @param {String} [libPath]
* @returns {String}
* @public
*/
getLevel1Id: function (path, libPath) {
@ -217,8 +217,8 @@ const manageFolder = (function () {
},
/**
* 判断一个文件夹是否为 amWiki 文库项目
* @param {string} path - 需要判断的文件夹路径
* @returns {boolean|string} 判断为否时返回 false，判断为真时返回项目根目录的路径
* @param {String} path - 需要判断的文件夹路径
* @returns {Boolean|String} 判断为否时返回 false，判断为真时返回项目根目录的路径
* @public
*/
isAmWiki: function (path) {

24
build/manageWiki.js
View File

@ -16,7 +16,7 @@ const manageWiki = (function () {
_wikis: null,
/**
* 绑定文库记录
* @param {object} wikis - 文库记录列表的引用
* @param {Object} wikis - 文库记录列表的引用
* @public
*/
linkWikis: function (wikis) {
@ -24,7 +24,7 @@ const manageWiki = (function () {
},
/**
* 获取所有文库记录
* @returns {object}
* @returns {Object}
* @public
*/
getWikis: function () {
@ -32,8 +32,8 @@ const manageWiki = (function () {
},
/**
* 通过 root 地址获取单个文库记录
* @param {string} root
* @returns {object}
* @param {String} root
* @returns {Object}
* @public
*/
getWikiByRoot: function (root) {
@ -48,8 +48,8 @@ const manageWiki = (function () {
},
/**
* 添加一个文库到记录
* @param {string} root - 文库根目录
* @param {number} [id] - 文库的计算id
* @param {String} root - 文库根目录
* @param {Number} [id] - 文库的计算id
* @public
*/
addWiki: function (root, id = this.createWikiId(root)) {
@ -79,8 +79,8 @@ const manageWiki = (function () {
},
/**
* 计算文库id
* @param {string} root - 需要计算id的文库根目录
* @returns {number} 文库id，由根目录路径字符串计算而来
* @param {String} root - 需要计算id的文库根目录
* @returns {Number} 文库id，由根目录路径字符串计算而来
* @public
*/
createWikiId: function (root) {
@ -96,7 +96,7 @@ const manageWiki = (function () {
},
/**
* 判断文库是否加入记录，未加入则补录
* @param {string} path - 需要判断的路径
* @param {String} path - 需要判断的路径
* @public
*/
checkAddWiki: function (path) {
@ -112,7 +112,7 @@ const manageWiki = (function () {
},
/**
* 检查文库是否仍然有效，失效则标记弃用
* @param {number} wId - 需要判断的文库id
* @param {Number} wId - 需要判断的文库id
* @public
*/
checkWikiValid: function (wId) {
@ -149,8 +149,8 @@ const manageWiki = (function () {
},
/**
* 重新解析/过滤 config 配置
* @param {object} config
* @return {object} config
* @param {Object} config
* @return {Object} config
* @public
*/
parseConfig: function (config) {

34
build/server.class.js
View File

@ -32,14 +32,14 @@ const MimeType = {
};
/**
* @class
* @class Server
*/
class Server {
/**
* @constructor
* @param wikis
* @param port
* @param {[Object]} wikis
* @param {Number} port=5171
*/
constructor(wikis, port = 5171) {
this._wikis = wikis;
@ -86,7 +86,7 @@ class Server {
/**
* 获取本地ip
* @returns {string} 本地ip地址
* @returns {String} 本地ip地址
* @public
*/
getLocalIP() {
@ -109,7 +109,7 @@ class Server {
/**
* 获取当前 server 监听的端口
* @return {number} 端口号
* @return {Number} 端口号
* @public
*/
getPort() {
@ -126,8 +126,8 @@ class Server {
/**
* 解析请求
* @param {object} req - 请求体
* @param {object} res - 响应体
* @param {Object} req - 请求体
* @param {Object} res - 响应体
* @private
*/
_parse(req, res) {
@ -182,8 +182,8 @@ class Server {
/**
* 渲染索引页
* @param {object} req - 请求体
* @param {object} res - 响应体
* @param {Object} req - 请求体
* @param {Object} res - 响应体
* @private
*/
_renderIndexPage(req, res) {
@ -254,7 +254,13 @@ class Server {
res.end();
}
//404未找到页面
/**
* 404未找到页面
* @param {Object} req
* @param {Object} res
* @param {String} path
* @static
*/
static page404(req, res, path) {
res.writeHead(404, {
'Content-Type': 'text/html'
@ -266,7 +272,13 @@ class Server {
res.end();
}
//500错误页面
/**
* 500错误页面
* @param {Object} req
* @param {Object} res
* @param {Error} error
* @static
*/
static page500(req, res, error) {
res.writeHead(500, {
'Content-Type': 'text/html'

4
build/tools.js
View File

@ -8,8 +8,8 @@ const tools = (function () {
return {
/**
* 判断一个对象是否属于数组
* @param {object} obj - 需要判断的对象
* @return {boolean}
* @param {Object} obj - 需要判断的对象
* @return {Boolean}
* @public
*/
isArray: function (obj) {

22
files/amWiki.docs.js
View File

@ -13,7 +13,8 @@
var URL_ENCODE_NAME = 'AMWikiUrlEncode'; //记录url编码的键名
/**
* @class 创建一个文档管理对象
* 文档管理
* @constructor
*/
var Docs = function () {
this.$e = {
@ -282,8 +283,8 @@
};
/**
* @desc 渲染文档
* @param content {string} - 需要渲染的文档内容
* 渲染文档
* @param {String} content - 需要渲染的文档内容
*/
Docs.prototype.renderDoc = function (content) {
var that = this;
@ -353,14 +354,11 @@
};
/**
* @callback loadPageCallback
* @param type {string} - 加载页面最终状态，success、error 两种
* @param content {string} - 加载页面成功时，传递加载的内容
*/
/**
* @desc 加载指定页面
* @param path {string} - 页面资源地址
* @param callback {loadPageCallback} - 加载完成后的回调
* 加载指定页面
* @param {String} path - 页面资源地址
* @param {Function} callback - 加载完成后的回调，包含参数：
* type - 加载页面最终状态，success、error 两种
* content - 加载页面成功时，传递加载的内容
*/
Docs.prototype.loadPage = function (path, callback) {
//console.log(path);
@ -388,7 +386,7 @@
};
/**
* @desc 清理页面
* 清理页面
*/
Docs.prototype.cleanView = function () {
this.$e.view.find('.lang-off-js-comment').off('click');

5
files/amWiki.imgsView.js
View File

@ -7,6 +7,11 @@
'use strict';
/**
* 图片查看器
* @param {Object} _this
* @constructor
*/
var ImgsView = function (_this) {
this.$e = {
container: $(_this), //文档主容器

6
files/amWiki.js
View File

@ -195,16 +195,16 @@ $(function () {
*/
/**
* @desc 向下递归进行导航筛选
* 向下递归进行导航筛选
* 当类型为筛选时，必定有正则
* 当文件夹匹配时，其所属链接和所有子级全部显示且显示匹配
* 当文件夹不匹配时，其所属链接和当前子级仅显示匹配，隐藏不匹配的项，下一级继续筛选
* 当类型为打开时，所属链接和子级一律全部显示不隐藏
* 如果有正则，显示当前匹配
* 如果无正则，清除匹配
* @param {string} type - 筛选类型，有 filter / open 两个值
* @param {String} type - 筛选类型，有 filter / open 两个值
* @param {regexp} valReg - 过滤筛选的正则
* @param {object} $title - jquery 对象，“标题-列表”DOM结构中的标题
* @param {Object} $title - jquery 对象，“标题-列表”DOM结构中的标题
*/
var filterNav = function (type, valReg, $title) {
var $ul = $title.next('ul');

5
files/amWiki.scrollbar.js
View File

@ -16,6 +16,11 @@
}
}, 500);
/**
* 页面滚动
* @param {Object} _this
* @constructor
*/
var Scroller = function (_this) {
this.$e = {
container: $(_this), //主容器

4
files/amWiki.search.js
View File

@ -9,7 +9,9 @@
'use strict';
/**
* @class 创建全局搜索
* 全局搜索
* @param {Storage} _storage
* @constructor
*/
var Search = function (_storage) {
this._storage = _storage;

4
files/amWiki.search.worker.js
View File

@ -11,6 +11,10 @@
//计算器
var searcher = (function () {
/**
* 搜索计算器
* @constructor
*/
var Searcher = function () {
//文档存储
this._documents = null;

29
files/amWiki.storage.js
View File

@ -14,7 +14,8 @@
var LOCAL_STATES = 'AMWikiStates@' + wikiPath; //本地状态集键名
/**
* @class 创建一个本地存储管理对象
* 本地存储管理
* @constructor
*/
var Storage = function () {
this._db = null; //内存中的文库缓存
@ -74,10 +75,10 @@
};
/**
* @desc 保存一篇文档
* @param uri {string} - 文档资源地址
* @param content {string} - 文档内容
* @param [id] {string} - 已经编码的文档地址，可选
* 保存一篇文档
* @param {String} uri - 文档资源地址
* @param {String} content - 文档内容
* @param {String} [id] - 已经编码的文档地址，可选
*/
Storage.prototype.saveDoc = function (uri, content, id) {
this.saveDocToDB(uri, content, id);
@ -103,9 +104,9 @@
};
/**
* @desc 读取一篇文档
* @param uri {string} - 文档资源地址
* @returns {string} - 文档内容
* 读取一篇文档
* @param {String} uri - 文档资源地址
* @returns {String} 文档内容
*/
Storage.prototype.read = function (uri) {
var id = tools.simString(uri, 'short');
@ -118,8 +119,8 @@
/**
* 读取一篇文档的时间
* @param uri {string} - 文档资源地址
* @returns {string} - 文档内容
* @param {String} uri - 文档资源地址
* @returns {String} 文档内容
*/
Storage.prototype.readTime = function (uri) {
var id = tools.simString(uri, 'short');
@ -131,8 +132,8 @@
};
/**
* @desc 删除一篇文档
* @param uri {string} - 文档资源地址
* 删除一篇文档
* @param {String} uri - 文档资源地址
*/
Storage.prototype.remove = function (uri) {
var id = tools.simString(uri, 'short');
@ -148,8 +149,8 @@
};
/**
* @desc 校对列表，清除失效文档
* @param list {Array} - 由导航树偏平化生成的文档列表
* 校对列表，清除失效文档
* @param {Array} list - 由导航树偏平化生成的文档列表
*/
Storage.prototype.checkLibChange = function (list) {
this._indexing = list;

5
files/amWiki.testing.js
View File

@ -10,7 +10,8 @@
'use strict';
/**
* @class 创建接口测试
* 建接口测试
* @constructor
*/
var Testing = function () {
//缓存元素
@ -53,7 +54,7 @@
};
/**
* @desc 抓取请求内容，抓取成功才显示按钮
* 抓取请求内容，抓取成功才显示按钮
*/
Testing.prototype.crawlContent = function () {
var that = this;

26
files/amWiki.tools.js
View File

@ -11,9 +11,9 @@
return win.tools = {
/**
* @desc 获取url参数
* @param name {string}
* @returns {string|null} - 获取的参数
* 获取url参数
* @param {String} name
* @returns {String|Null} - 获取的参数
*/
getURLParameter: function (name) {
var reg = new RegExp("(^|&)" + name + "=([^&]*)(&|$)", "i");
@ -26,10 +26,10 @@
},
/**
* @desc 转换字符中每个汉字为两个字符
* @param str {string} - 要编码的字符串
* @param [mod] {string} - 编码模式选择，可选，normal(默认)一个汉字对应两位字符，short一个汉字对应一位字符
* @returns {string} - 编码后的字符串
* 转换字符中每个汉字为两个字符
* @param {String} str - 要编码的字符串
* @param {String} [mod] - 编码模式选择，可选，normal(默认)一个汉字对应两位字符，short一个汉字对应一位字符
* @returns {String} 编码后的字符串
*/
simString: function (str, mod) {
mod = mod == 'short'; //短字符串
@ -59,9 +59,9 @@
},
/**
* @desc json格式化
* @param str {string} - 需要格式化的json字符串
* @returns {string} - 格式化后的json字符串
* json格式化
* @param {String} str - 需要格式化的json字符串
* @returns {String} 格式化后的json字符串
*/
formatJson: function (str) {
var json = decodeURI(str.replace(/%([^0-9A-Z]{0,2})/g, '%25$1'));
@ -130,9 +130,9 @@
},
/**
* @desc 时间戳格式化为日期时间
* @param timestamp {number} - 时间戳
* @returns {string} - 日期时间
* 时间戳格式化为日期时间
* @param {Number} timestamp - 时间戳
* @returns {String} 日期时间
*/
formatTime: function (timestamp) {
var time = new Date(timestamp);

8
lib/autoNavigation.js
View File

@ -132,8 +132,8 @@ const autoNavigation = (function () {
},
/**
* 推测当前文库是哪一个
* @param {function} callback
* @param {number} recursive - 递归次数标记
* @param {Function} callback
* @param {Number} recursive - 递归次数标记
* @private
*/
_getCurLib: function (callback, recursive = 1) {
@ -169,7 +169,7 @@ const autoNavigation = (function () {
},
/**
* 检查文库变化
* @param {string} wId
* @param {String} wId
* @private
*/
_checkLibChange: function (wId) {
@ -192,7 +192,7 @@ const autoNavigation = (function () {
},
/**
* 监听发起
* @param {object} wikis - 文库记录列表的引用
* @param {[Object]} wikis - 文库记录列表的引用
* @public
*/
start: function (wikis) {

10
lib/dropFile.js
View File

@ -17,10 +17,10 @@ const dropFile = (function () {
_getEditorPath: null,
/**
* 拖拽图片
* @param {[object...]} files - 鼠标拖拽的文件列表
* @param {string} createDirPath - 输出的目录
* @param {string} insertText - 插入的文本
* @param {object} editor - 编辑器的引用
* @param {[Object]} files - 鼠标拖拽的文件列表
* @param {String} createDirPath - 输出的目录
* @param {String} insertText - 插入的文本
* @param {Object} editor - 编辑器的引用
* @private
*/
_dropImg: function (files, createDirPath, insertText, editor) {
@ -47,7 +47,7 @@ const dropFile = (function () {
},
/**
* 监听拖拽
* @param {function} getEditorPath - 获取编辑器当前文档状态的方法的引用
* @param {Function} getEditorPath - 获取编辑器当前文档状态的方法的引用
* @public
*/
listenDrop: function (getEditorPath) {

6
lib/main.js
View File

@ -56,7 +56,7 @@ const main = (function () {
_wikis: null,
/**
* 当atom启动时
* @param {object} state
* @param {Object} state
* @public
*/
activate: function (state) {
@ -236,7 +236,7 @@ const main = (function () {
},
/**
* 当atom窗口被挂起，保存文库列表
* @returns {{config: object, wikis: [object]}}
* @returns {{config: Object, wikis: [Object]}}
* @public
*/
serialize: function () {
@ -261,7 +261,7 @@ const main = (function () {
},
/**
* 获取当前文档路径，先检查当前是否处于文档编辑状态才返回
* @returns {[boolean, object, string]}
* @returns {[Boolean|Object|String]}
* @private
*/
_getEditorPath: function () {

8
lib/pageCatalogue.js
View File

@ -7,7 +7,7 @@ const pageCatalogue = (function () {
return {
/**
* 生成文章目录
* @param {object} editor - 当前文档编辑器的引用
* @param {Object} editor - 当前文档编辑器的引用
* @public
*/
make: function (editor) {
@ -15,7 +15,7 @@ const pageCatalogue = (function () {
},
/**
* 抽取标题
* @param {string} arc
* @param {String} arc
* @private
*/
_extract: function (arc) {
@ -66,8 +66,8 @@ const pageCatalogue = (function () {
},
/**
* 修剪标题文本
* @param {string} titleStr
* @returns {string}
* @param {String} titleStr
* @returns {String}
* @private
*/
_trimTitle: function (titleStr) {

16
lib/richPaste.js
View File

@ -18,8 +18,8 @@ const richPaste = (function () {
_editPath: null,
/**
* 富粘贴
* @param {object} editor - 当前文档编辑器的引用
* @param {string} editPath - 当前文档的路径
* @param {Object} editor - 当前文档编辑器的引用
* @param {String} editPath - 当前文档的路径
* @public
*/
paste: function (editor, editPath) {
@ -73,10 +73,10 @@ const richPaste = (function () {
},
/**
* 粘贴图片
* @param {string} type - 粘贴的类型：file / clip
* @param {string} filePath - 需要读取的图片路径
* @param {function} callback - 粘贴处理后的回调（是否成功的状态，图片src路径，图片title）
* @param {object} editor - 当前编辑器的引用
* @param {String} type - 粘贴的类型：file / clip
* @param {String} filePath - 需要读取的图片路径
* @param {Function} callback - 粘贴处理后的回调（是否成功的状态，图片src路径，图片title）
* @param {Object} editor - 当前编辑器的引用
* @private
*/
_pasteImg: function (type, filePath, callback, editor) {
@ -134,8 +134,8 @@ const richPaste = (function () {
},
/**
* 计算操作路径
* @param {string} [editPath] - 当前文档的路径
* @returns {object} 粘贴图片需要的路径列表
* @param {String} [editPath] - 当前文档的路径
* @returns {Object} 粘贴图片需要的路径列表
* @public
*/
getPastePaths: function (editPath = this._editPath) {