JSDoc: Fix some missing complex returns types

Also a stray @mixins.

Change-Id: I6eb6c43aedd36824b2e7c8e8082f73b8a03bbd53
这个提交包含在:
Ed Sanders 2024-04-30 17:27:13 +01:00
父节点 e15ab6328d
当前提交 5bbdc2f3ec
共有 3 个文件被更改,包括 24 次插入14 次删除

查看文件

@ -3,7 +3,7 @@
*
* @class
* @extends OO.ui.Element
* @mixins OO.EventEmitter
* @mixes OO.EventEmitter
*
* @constructor
* @param {ve.init.Target} target

查看文件

@ -31,16 +31,21 @@ OO.initClass( ve.dm.RebaseDocState );
/* Static Methods */
/**
* @typedef {Object} AuthorData
* @memberof ve.dm.RebaseDocState
* @property {string} name
* @property {string} color
* @property {number} rejections Number of unacknowledged rejections
* @property {ve.dm.Change|null} continueBase Continue base
* @property {string} token Secret token for usurping sessions
* @property {boolean} active Whether the author is active
*/
/**
* Get new empty author data object
*
* @return {Object} New empty author data object
* @return {string} return.name
* @return {string} return.color
* @return {number} return.rejections Number of unacknowledged rejections
* @return {ve.dm.Change|null} return.continueBase Continue base
* @return {string} return.token Secret token for usurping sessions
* @return {boolean} return.active Whether the author is active
* @return {ve.dm.RebaseDocState.AuthorData} New empty author data object
*/
ve.dm.RebaseDocState.static.newAuthorData = function () {
return {

查看文件

@ -28,15 +28,20 @@ ve.ce.TestOffset = function VeCeTestOffset( direction, offset ) {
this.lastSel = null;
};
/**
* @typedef {Object} OffsetInfo
* @memberof ve.ce.TestOffset
* @property {number} [consumed] The number of code units consumed (if n out of range)
* @property {Node} [node] The node containing the offset (if n in range)
* @property {number} [offset] The offset in code units / child elements (if n in range)
* @property {string} [slice] String representation of the offset position (if n in range)
*/
/**
* Calculate the offset from each end of a particular HTML string
*
* @param {Node} node The DOM node with respect to which the offset is resolved
* @return {Object} Offset information
* @return {number} [return.consumed] The number of code units consumed (if n out of range)
* @return {Node} [return.node] The node containing the offset (if n in range)
* @return {number} [return.offset] The offset in code units / child elements (if n in range)
* @return {string} [return.slice] String representation of the offset position (if n in range)
* @return {ve.ce.TestOffset.OffsetInfo} Offset information
*/
ve.ce.TestOffset.prototype.resolve = function ( node ) {
var reversed = ( this.direction !== 'forward' );
@ -55,7 +60,7 @@ ve.ce.TestOffset.static = {};
* @param {Node} node
* @param {number} n Offset
* @param {boolean} reversed
* @return {Object} Offset information
* @return {ve.ce.TestOffset.OffsetInfo} Offset information
*/
ve.ce.TestOffset.static.findTextOffset = function ( node, n, reversed ) {
if ( node.nodeType === node.TEXT_NODE ) {