Prtksxna has uploaded a new change for review. ( https://gerrit.wikimedia.org/r/405544 )
Change subject: docs: use JSDoc3 instead of jsduck ...................................................................... docs: use JSDoc3 instead of jsduck Change-Id: I85d8cbfc1873752d5938e167eacefa177e7a4396 --- A jsdoc.json D jsduck.categories.json D jsduck.json M package.json M src/EmitterList.js M src/EventEmitter.js M src/Registry.js M src/SortedEmitterList.js 8 files changed, 36 insertions(+), 60 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/oojs/core refs/changes/44/405544/1 diff --git a/jsdoc.json b/jsdoc.json new file mode 100644 index 0000000..240d3c0 --- /dev/null +++ b/jsdoc.json @@ -0,0 +1,16 @@ +{ + "source": { + "include": [ "src/" ] + }, + "plugins": [ + "plugins/markdown" + ], + "opts": { + "source": "src/**/*.js", + "tutorials": "", + "recurse": true, + "readme": "README.md", + "package": "package.json", + "destination": "docs/" + } +} diff --git a/jsduck.categories.json b/jsduck.categories.json deleted file mode 100644 index 3bae581..0000000 --- a/jsduck.categories.json +++ /dev/null @@ -1,32 +0,0 @@ -[ - { - "name": "OOjs", - "groups": [ - { - "name": "OO", - "classes": [ - "OO", - "OO.*" - ] - } - ] - }, - { - "name": "Upstream", - "groups": [ - { - "name": "JavaScript", - "classes": [ - "Array", - "Boolean", - "Date", - "Function", - "Number", - "Object", - "RegExp", - "String" - ] - } - ] - } -] diff --git a/jsduck.json b/jsduck.json deleted file mode 100644 index e5971ec..0000000 --- a/jsduck.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "--title": "OOjs - Documentation", - "--output": "docs", - "--categories": "./jsduck.categories.json", - "--processes": "0", - "--warnings-exit-nonzero": true, - "--builtin-classes": true, - "--": [ - "src/" - ] -} diff --git a/package.json b/package.json index 7e04192..013a111 100644 --- a/package.json +++ b/package.json @@ -19,7 +19,7 @@ "filename": "oojs.min.js", "scripts": { "test": "grunt test && node tests/node-index.js", - "doc": "jsduck", + "doc": "jsdoc -c jsdoc.json", "prepublish": "grunt build" }, "dependencies": {}, @@ -34,6 +34,7 @@ "grunt-eslint": "20.0.0", "grunt-karma": "2.0.0", "jquery": "3.2.1", + "jsdoc": "^3.5.5", "karma": "1.5.0", "karma-chrome-launcher": "2.2.0", "karma-coverage": "1.1.1", diff --git a/src/EmitterList.js b/src/EmitterList.js index 29d5b7a..c3d02e3 100644 --- a/src/EmitterList.js +++ b/src/EmitterList.js @@ -21,7 +21,7 @@ /** * Item has been added * - * @event add + * @event oo.EmitterList#add * @param {OO.EventEmitter} item Added item * @param {number} index Index items were added at */ @@ -29,7 +29,7 @@ /** * Item has been moved to a new index * - * @event move + * @event oo.EmitterList#move * @param {OO.EventEmitter} item Moved item * @param {number} index Index item was moved to * @param {number} oldIndex The original index the item was in @@ -38,13 +38,15 @@ /** * Item has been removed * - * @event remove + * @event oo.EmitterList#remove * @param {OO.EventEmitter} item Removed item * @param {number} index Index the item was removed from */ /** - * @event clear The list has been cleared of items + * The list has been cleared of items + * + * @event oo.EmitterList#clear */ /* Methods */ @@ -166,8 +168,8 @@ * given, or if the index that is given is invalid, the item * will be added at the end of the list. * @chainable - * @fires add - * @fires move + * @fires oo.EmitterList#add + * @fires oo.EmitterList#move */ oo.EmitterList.prototype.addItems = function ( items, index ) { var i, oldIndex; @@ -280,7 +282,7 @@ * * @param {OO.EventEmitter[]} items Items to remove * @chainable - * @fires remove + * @fires oo.EmitterList#remove */ oo.EmitterList.prototype.removeItems = function ( items ) { var i, item, index; @@ -314,7 +316,7 @@ * Clear all items * * @chainable - * @fires clear + * @fires oo.EmitterList#clear */ oo.EmitterList.prototype.clearItems = function () { var i, item, diff --git a/src/EventEmitter.js b/src/EventEmitter.js index 3e9d05d..2d7f5d7 100644 --- a/src/EventEmitter.js +++ b/src/EventEmitter.js @@ -13,7 +13,7 @@ /** * Storage of bound event handlers by event name. * - * @property + * @property {Object} bindings */ this.bindings = {}; }; diff --git a/src/Registry.js b/src/Registry.js index f27e501..ca02ce5 100644 --- a/src/Registry.js +++ b/src/Registry.js @@ -2,7 +2,7 @@ /** * @class OO.Registry - * @mixins OO.EventEmitter + * @mixes OO.EventEmitter * * @constructor */ @@ -21,13 +21,13 @@ /* Events */ /** - * @event register + * @event oo.Registry#register * @param {string} name * @param {Mixed} data */ /** - * @event unregister + * @event oo.Registry#unregister * @param {string} name * @param {Mixed} data Data removed from registry */ @@ -41,7 +41,7 @@ * * @param {string|string[]} name Symbolic name or list of symbolic names * @param {Mixed} data Data to associate with symbolic name - * @fires register + * @fires oo.Registry#register * @throws {Error} Name argument must be a string or array */ oo.Registry.prototype.register = function ( name, data ) { @@ -62,7 +62,7 @@ * Remove one or more symbolic names from the registry * * @param {string|string[]} name Symbolic name or list of symbolic names - * @fires unregister + * @fires oo.Registry#unregister * @throws {Error} Name argument must be a string or array */ oo.Registry.prototype.unregister = function ( name ) { diff --git a/src/SortedEmitterList.js b/src/SortedEmitterList.js index 28a2184..5ca861f 100644 --- a/src/SortedEmitterList.js +++ b/src/SortedEmitterList.js @@ -13,7 +13,7 @@ * * @abstract * @class OO.SortedEmitterList - * @mixins OO.EmitterList + * @mixes OO.EmitterList * @constructor * @param {Function} sortingCallback Callback that compares two items. */ @@ -43,7 +43,7 @@ * inside the list. * * @private - * @event itemSortChange + * @event oo.SortedEmitterList#itemSortChange */ /* Methods */ -- To view, visit https://gerrit.wikimedia.org/r/405544 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I85d8cbfc1873752d5938e167eacefa177e7a4396 Gerrit-PatchSet: 1 Gerrit-Project: oojs/core Gerrit-Branch: master Gerrit-Owner: Prtksxna <psax...@wikimedia.org> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits