mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/DiscussionTools
synced 2024-09-23 18:38:18 +00:00
Merge "Better document {Object} types"
This commit is contained in:
commit
6c1550b66e
|
@ -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 {
|
||||
|
|
|
@ -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
|
||||
*/
|
||||
|
|
|
@ -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
|
||||
*/
|
||||
|
|
Loading…
Reference in a new issue