From: Timo Tijhof Date: Thu, 3 Apr 2014 01:05:13 +0000 (-0700) Subject: mediawiki.html: Add missing @return documentation X-Git-Tag: 1.31.0-rc.0~16386^2 X-Git-Url: http://git.cyclocoop.org//%22%22.url_de_base%28%29.%22/%22?a=commitdiff_plain;h=3014a6ede1971048140b19964752b439600bcd8b;p=lhc%2Fweb%2Fwiklou.git mediawiki.html: Add missing @return documentation Change-Id: I63f12ee44aace6cf4f7762dd67244648b95d7301 --- diff --git a/resources/mediawiki/mediawiki.js b/resources/mediawiki/mediawiki.js index d8a17f6269..885fd3da65 100644 --- a/resources/mediawiki/mediawiki.js +++ b/resources/mediawiki/mediawiki.js @@ -2218,12 +2218,15 @@ var mw = ( function ( $, undefined ) { return { /** - * Escape a string for HTML. Converts special characters to HTML entities. + * Escape a string for HTML. + * + * Converts special characters to HTML entities. * * mw.html.escape( '< > \' & "' ); * // Returns < > ' & " * * @param {string} s The string to escape + * @return {string} HTML */ escape: function ( s ) { return s.replace( /['"<>&]/g, escapeCallback ); @@ -2242,6 +2245,7 @@ var mw = ( function ( $, undefined ) { * - this.Cdata: The value attribute is included, and an exception is * thrown if it contains an illegal ETAGO delimiter. * See . + * @return {string} HTML */ element: function ( name, attrs, contents ) { var v, attrName, s = '<' + name;