wikimedia/mediawiki-extensions-DiscussionTools
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/DiscussionTools synced 2024-09-23 18:38:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "Better document {Object} types"

Browse source
This commit is contained in:
jenkins-bot 2021-12-20 21:38:09 +00:00 committed by Gerrit Code Review
parent 640638b1dc 2e1241289c
commit 6c1550b66e
3 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
modules/CommentController.js
View file

@ -238,7 +238,7 @@ CommentController.prototype.teardown = function ( abandoned ) {
* @param {ThreadItem} comment Parent comment
* @param {string} pageName Title of the page to post on
* @param {Object} checkboxes Value of the promise returned by controller#getCheckboxesPromise
* @return {Object}
* @return {Object.<string,string>} API query data
*/
CommentController.prototype.getApiQuery = function ( comment, pageName, checkboxes ) {
var replyWidget = this.replyWidget;
@ -416,7 +416,7 @@ CommentController.prototype.undoIndentReplacements = function ( rootNode ) {
* Get the list of selectors that match nodes that can't be inserted in the comment. (We disallow
* things that generate wikitext syntax that may conflict with list item syntax.)
*
* @return {Object} Map of type used for error messages (string) to CSS selector (string)
* @return {Object.<string,string>} Map of type used for error messages (string) to CSS selector (string)
*/
CommentController.prototype.getUnsupportedNodeSelectors = function () {
return {

4
modules/Parser.js
View file

@ -56,7 +56,7 @@ function getMessages( contLangVariant, messages ) {
* @param {string} contLangVariant Content language variant
* @param {string} format Date format, as used by MediaWiki
* @param {string} digitsRegexp Regular expression matching a single localised digit, e.g. `[0-9]`
* @param {Object} tzAbbrs Map of localised timezone abbreviations to IANA abbreviations
* @param {Object.<string,string>} tzAbbrs Map of localised timezone abbreviations to IANA abbreviations
* for the local timezone, e.g. `{EDT: "EDT", EST: "EST"}`
* @return {string} Regular expression
*/
@ -189,7 +189,7 @@ Parser.prototype.getTimestampRegexp = function ( contLangVariant, format, digits
* @param {string} format Date format, as used by MediaWiki
* @param {string[]|null} digits Localised digits from 0 to 9, e.g. `[ '0', '1', ..., '9' ]`
* @param {string} localTimezone Local timezone IANA name, e.g. `America/New_York`
* @param {Object} tzAbbrs Map of localised timezone abbreviations to IANA abbreviations
* @param {Object.<string,string>} tzAbbrs Map of localised timezone abbreviations to IANA abbreviations
* for the local timezone, e.g. `{EDT: "EDT", EST: "EST"}`
* @return {TimestampParser} Timestamp parser function
*/

2
modules/ThreadItem.js
View file

@ -47,7 +47,7 @@ OO.initClass( ThreadItem );
* Create a new ThreadItem from a JSON serialization
*
* @param {string|Object} json JSON serialization or hash object
* @param {Object} commentsById Collection of comments by ID for building replies/parent pointers
* @param {Object.<string,ThreadItem>} commentsById Collection of comments by ID for building replies/parent pointers
* @return {ThreadItem}
* @throws {Error} Unknown ThreadItem type
*/