Merge "objectcache: Hard deprecate `ObjectCache::getMainWANInstance()`"
[lhc/web/wiklou.git] / resources / src / jquery / jquery.highlightText.js
index a6b9373..7205620 100644 (file)
@@ -3,7 +3,7 @@
  * TODO: Add a function for restoring the previous text.
  * TODO: Accept mappings for converting shortcuts like WP: to Wikipedia:.
  */
-( function ( $, mw ) {
+( function () {
 
        $.highlightText = {
 
@@ -35,7 +35,7 @@
                        var i, match, pos, spannode, middlebit, middleclone;
                        if ( node.nodeType === Node.TEXT_NODE ) {
                                // TODO - need to be smarter about the character matching here.
-                               // non latin characters can make regex think a new word has begun: do not use \b
+                               // non Latin characters can make regex think a new word has begun: do not use \b
                                // http://stackoverflow.com/questions/3787072/regex-wordwrap-with-utf8-characters-in-js
                                // look for an occurrence of our pattern and store the starting position
                                match = node.data.match( pat );
@@ -81,7 +81,8 @@
         * @param {string} [options.method='splitAndHighlight'] Method of matching to use, one of:
         *   - 'splitAndHighlight': Split `matchString` on spaces, then match each word separately.
         *   - 'prefixHighlight': Match `matchString` at the beginning of text only.
-        * @return {[type]} [description]
+        * @return {jQuery}
+        * @chainable
         */
        $.fn.highlightText = function ( matchString, options ) {
                options = options || {};
@@ -93,4 +94,4 @@
                } );
        };
 
-}( jQuery, mediaWiki ) );
+}() );