JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.4.2
[ckeditor.git] / _source / core / lang.js
index add9982..541b7a4 100644 (file)
@@ -7,6 +7,9 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 {\r
        var loadedLangs = {};\r
 \r
+       /**\r
+        * @namespace Holds language related functions.\r
+        */\r
        CKEDITOR.lang =\r
        {\r
                /**\r
@@ -81,12 +84,11 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                 * Loads a specific language file, or auto detect it. A callback is\r
                 * then called when the file gets loaded.\r
                 * @param {String} languageCode The code of the language file to be\r
-                *              loaded. If "autoDetect" is set to true, this language will be\r
-                *              used as the default one, if the detect language is not\r
-                *              available in the core.\r
-                * @param {Boolean} autoDetect Indicates that the function must try to\r
-                *              detect the user language and load it instead.\r
-                * @param {Function} callback The function to be called once the\r
+                *              loaded. If null or empty, autodetection will be performed. The\r
+                *              same happens if the language is not supported.\r
+                * @param {String} defaultLanguage The language to be used if\r
+                *              languageCode is not supported or if the autodetection fails.\r
+                * @param {Function} callback A function to be called once the\r
                 *              language file is loaded. Two parameters are passed to this\r
                 *              function: the language code and the loaded language entries.\r
                 * @example\r
@@ -121,6 +123,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                 * supported, a default language is then returned.\r
                 * @param {String} defaultLanguage The default language to be returned\r
                 *              if the user language is not supported.\r
+                * @param {String} [probeLanguage] A language code to try to use,\r
+                *              instead of the browser based autodetection.\r
                 * @returns {String} The detected language code.\r
                 * @example\r
                 * alert( CKEDITOR.lang.detect( 'en' ) );  // e.g., in a German browser: "de"\r