]> git.immae.eu Git - perso/Immae/Projets/packagist/connexionswing-ckeditor-component.git/blobdiff - sources/plugins/scayt/plugin.js
Upgrade to 4.5.7 and add some plugin
[perso/Immae/Projets/packagist/connexionswing-ckeditor-component.git] / sources / plugins / scayt / plugin.js
index ef31526360e310f0ad5dd7d5b1263e9ac6c52a97..8c361b8077aea77d979e25fbb6411ec32ba0271e 100644 (file)
@@ -264,7 +264,7 @@ CKEDITOR.plugins.add('scayt', {
                        plugin.destroy(editor);\r
                };\r
 \r
-               /**\r
+               /*\r
                 * Dirty fix for placeholder drag&drop\r
                 * Should be fixed with next release\r
                 */\r
@@ -320,7 +320,7 @@ CKEDITOR.plugins.add('scayt', {
                        if(inline_mode) {\r
 \r
                                if (!editor.config.scayt_inlineModeImmediateMarkup) {\r
-                                       /**\r
+                                       /*\r
                                         * Give an opportunity to CKEditor to perform all needed updates\r
                                         * and only after that call 'scaytDestroy' method (#72725)\r
                                         */\r
@@ -343,7 +343,7 @@ CKEDITOR.plugins.add('scayt', {
 \r
                        addMarkupStateHandlers();\r
 \r
-                       /**\r
+                       /*\r
                         * 'mousedown' handler handle widget selection (click on widget). To\r
                         * fix the issue when widget#wrapper referenced to element which can\r
                         * be broken after markup.\r
@@ -433,7 +433,7 @@ CKEDITOR.plugins.add('scayt', {
                                        var scaytInstance = editor.scayt,\r
                                                scaytLangList = scaytInstance && scaytInstance.getScaytLangList();\r
 \r
-                                       /**\r
+                                       /*\r
                                         * Checks SCAYT initialization of LangList. To prevent immediate\r
                                         * markup which is triggered by 'startSpellCheck' event.\r
                                         * E.g.: Drop into inline CKEDITOR with scayt_autoStartup = true;\r
@@ -481,14 +481,14 @@ CKEDITOR.plugins.add('scayt', {
                        }\r
                }, this, null, 50);\r
 \r
-               /**\r
+               /*\r
                 * Main entry point to react on changes in document\r
                 */\r
                editor.on('reloadMarkupScayt', function(ev) {\r
                        var removeOptions = ev.data && ev.data.removeOptions,\r
                                timeout = ev.data && ev.data.timeout;\r
 \r
-                       /**\r
+                       /*\r
                         * Perform removeMarkupInSelectionNode and 'startSpellCheck' fire\r
                         * asynchroniosly and keep CKEDITOR flow as expected\r
                         */\r
@@ -496,14 +496,14 @@ CKEDITOR.plugins.add('scayt', {
                                var scaytInstance = editor.scayt,\r
                                        scaytLangList = scaytInstance && scaytInstance.getScaytLangList();\r
 \r
-                               /**\r
+                               /*\r
                                 * Checks SCAYT initialization of LangList. To prevent immediate\r
                                 * markup which is triggered by 'startSpellCheck' event.\r
                                 * E.g.: Drop into inline CKEDITOR with scayt_autoStartup = true;\r
                                 */\r
                                if (!scaytLangList || !(scaytLangList.ltr && scaytLangList.rtl)) return;\r
 \r
-                               /**\r
+                               /*\r
                                 * CKEditor can keep \u200B character in document (with selection#selectRanges)\r
                                 * we need to take care about that. For this case we fire\r
                                 * 'keydown' [left arrow], what will trigger 'removeFillingChar' on Webkit\r
@@ -1443,7 +1443,10 @@ CKEDITOR.on('scaytReady', function() {
 });\r
 \r
 /**\r
- * The parameter turns on/off SCAYT on the autostartup. If 'true', turns on SCAYT automatically after loading the editor.\r
+ * Automatically enables SCAYT on editor startup. When set to `true`, this option turns on SCAYT automatically\r
+ * after loading the editor.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
  *             config.scayt_autoStartup = true;\r
  *\r
@@ -1452,36 +1455,44 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter turns on/off Grammar As You Type (GRAYT) on the SCAYT startup. If 'true', turns on GRAYT automatically after SCAYT started.\r
+ * Enables Grammar As You Type (GRAYT) on SCAYT startup. When set to `true`, this option turns on GRAYT automatically\r
+ * after SCAYT started.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
  *             config.grayt_autoStartup = true;\r
  *\r
+ * @since 4.5.6\r
  * @cfg {Boolean} [grayt_autoStartup=false]\r
  * @member CKEDITOR.config\r
  */\r
 \r
 /**\r
- * The parameter turns on/off SCAYT initiation when Inline CKEditor is not focused. SCAYT markup is taken place (SCAYT instance is not destroyed)\r
- * in both Inline CKEditor's states, focused and unfocused.\r
+ * Enables SCAYT initialization when inline CKEditor is not focused. When set to `true`, SCAYT markup is\r
+ * displayed in both inline editor states, focused and unfocused, so the SCAYT instance is not destroyed.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
  *              config.scayt_inlineModeImmediateMarkup = true;\r
  *\r
+ * @since 4.5.6\r
  * @cfg {Boolean} [scayt_inlineModeImmediateMarkup=false]\r
  * @member CKEDITOR.config\r
  */\r
 \r
-\r
 /**\r
- * The parameter defines the number of SCAYT suggestions to show in the main context menu.\r
+ * Defines the number of SCAYT suggestions to show in the main context menu.\r
  * Possible values are:\r
  *\r
  * * `0` (zero) – No suggestions are shown in the main context menu. All\r
  *     entries will be listed in the "More Suggestions" sub-menu.\r
  * * Positive number – The maximum number of suggestions to show in the context\r
  *     menu. Other entries will be shown in the "More Suggestions" sub-menu.\r
- * * Negative number – 5 suggestions are shown in the main context menu. All other\r
+ * * Negative number – Five suggestions are shown in the main context menu. All other\r
  *     entries will be listed in the "More Suggestions" sub-menu.\r
  *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
+ *\r
  * Examples:\r
  *\r
  *             // Display only three suggestions in the main context menu.\r
@@ -1495,12 +1506,14 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter defines minimum length of the words that will be collected from editor's text for spell checking.\r
+ * Defines the minimum length of words that will be collected from the editor content for spell checking.\r
  * Possible value is any positive number.\r
  *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
+ *\r
  * Examples:\r
  *\r
- *             // Set minimum length of the words that will be collected from text.\r
+ *             // Set the minimum length of words that will be collected from editor text.\r
  *             config.scayt_minWordLength = 5;\r
  *\r
  * @cfg {Number} [scayt_minWordLength=4]\r
@@ -1508,9 +1521,11 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter sets the customer ID for SCAYT. Used for hosted users only. Required for migration from free\r
+ * Sets the customer ID for SCAYT. Used for hosted users only. Required for migration from free\r
  * to trial or paid versions.\r
  *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
+ *\r
  *             // Load SCAYT using my customer ID.\r
  *             config.scayt_customerId  = 'your-encrypted-customer-id';\r
  *\r
@@ -1519,9 +1534,11 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter enables/disables the "More Suggestions" sub-menu in the context menu.\r
+ * Enables and disables the "More Suggestions" sub-menu in the context menu.\r
  * Possible values are `'on'` and `'off'`.\r
  *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
+ *\r
  *             // Disables the "More Suggestions" sub-menu.\r
  *             config.scayt_moreSuggestions = 'off';\r
  *\r
@@ -1530,23 +1547,26 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter customizes the display of SCAYT context menu commands ("Add Word", "Ignore",\r
+ * Customizes the display of SCAYT context menu commands ("Add Word", "Ignore",\r
  * "Ignore All", "Options", "Languages", "Dictionaries" and "About").\r
  * This must be a string with one or more of the following\r
  * words separated by a pipe character (`'|'`):\r
  *\r
- * * `off` – disables all options.\r
- * * `all` – enables all options.\r
- * * `ignore` – enables the "Ignore" option.\r
- * * `ignoreall` – enables the "Ignore All" option.\r
- * * `add` – enables the "Add Word" option.\r
- * * `option` – enables "Options" menu item.\r
- * * `language` – enables "Languages" menu item.\r
- * * `dictionary` – enables "Dictionaries" menu item.\r
- * * `about` – enables "About" menu item.\r
- *\r
- * Note, that availability of 'Options', 'Languages' and 'Dictionaries' items\r
- * depends on scayt_uiTabs option also.\r
+ * * `off` – Disables all options.\r
+ * * `all` – Enables all options.\r
+ * * `ignore` – Enables the "Ignore" option.\r
+ * * `ignoreall` – Enables the "Ignore All" option.\r
+ * * `add` – Enables the "Add Word" option.\r
+ * * `option` – Enables the "Options" menu item.\r
+ * * `language` – Enables the "Languages" menu item.\r
+ * * `dictionary` – Enables the "Dictionaries" menu item.\r
+ * * `about` – Enables the "About" menu item.\r
+ *\r
+ * Please note that availability of the "Options", "Languages" and "Dictionaries" items\r
+ * also depends on the {@link CKEDITOR.config#scayt_uiTabs} option.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
+ *\r
  * Example:\r
  *\r
  *             // Show only "Add Word" and "Ignore All" in the context menu.\r
@@ -1557,12 +1577,14 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter sets the default spell checking language for SCAYT. Possible values are:\r
+ * Sets the default spell checking language for SCAYT. Possible values are:\r
  * `'en_US'`, `'en_GB'`, `'pt_BR'`, `'da_DK'`,\r
  * `'nl_NL'`, `'en_CA'`, `'fi_FI'`, `'fr_FR'`,\r
  * `'fr_CA'`, `'de_DE'`, `'el_GR'`, `'it_IT'`,\r
  * `'nb_NO'`, `'pt_PT'`, `'es_ES'`, `'sv_SE'`.\r
  *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
+ *\r
  *             // Sets SCAYT to German.\r
  *             config.scayt_sLang = 'de_DE';\r
  *\r
@@ -1571,11 +1593,13 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter customizes the SCAYT dialog and SCAYT toolbar menu to show particular tabs/items.\r
+ * Customizes the SCAYT dialog and SCAYT toolbar menu to show particular tabs and items.\r
  * This setting must contain a `1` (enabled) or `0`\r
  * (disabled) value for each of the following entries, in this precise order,\r
  * separated by a comma (`','`): `'Options'`, `'Languages'`, and `'Dictionary'`.\r
  *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
+ *\r
  *             // Hides the "Languages" tab.\r
  *             config.scayt_uiTabs = '1,0,1';\r
  *\r
@@ -1584,9 +1608,11 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter allows to specify protocol for WSC service (ssrv.cgi) full path.\r
+ * Sets the protocol for the WebSpellChecker service (`ssrv.cgi`) full path.\r
  *\r
- *             // Defines protocol for WSC service (ssrv.cgi) full path.\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
+ *\r
+ *             // Defines the protocol for the WebSpellChecker service (ssrv.cgi) path.\r
  *             config.scayt_serviceProtocol = 'https';\r
  *\r
  * @cfg {String} [scayt_serviceProtocol='http']\r
@@ -1594,9 +1620,11 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter allows to specify host for WSC service (ssrv.cgi) full path.\r
+ * Sets the host for the WebSpellChecker service (`ssrv.cgi`) full path.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
- *             // Defines host for WSC service (ssrv.cgi) full path.\r
+ *             // Defines the host for the WebSpellChecker service (ssrv.cgi) path.\r
  *             config.scayt_serviceHost = 'my-host';\r
  *\r
  * @cfg {String} [scayt_serviceHost='svc.webspellchecker.net']\r
@@ -1604,9 +1632,11 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter allows to specify port for WSC service (ssrv.cgi) full path.\r
+ * Sets the port for the WebSpellChecker service (`ssrv.cgi`) full path.\r
  *\r
- *             // Defines port for WSC service (ssrv.cgi) full path.\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
+ *\r
+ *             // Defines the port for the WebSpellChecker service (ssrv.cgi) path.\r
  *             config.scayt_servicePort = '2330';\r
  *\r
  * @cfg {String} [scayt_servicePort='80']\r
@@ -1614,9 +1644,11 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter allows to specify path for WSC service (ssrv.cgi) full path.\r
+ * Sets the path to the WebSpellChecker service (`ssrv.cgi`).\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
- *             // Defines host for WSC service (ssrv.cgi) full path.\r
+ *             // Defines the path to the WebSpellChecker service (ssrv.cgi).\r
  *             config.scayt_servicePath = 'my-path/ssrv.cgi';\r
  *\r
  * @cfg {String} [scayt_servicePath='spellcheck31/script/ssrv.cgi']\r
@@ -1624,9 +1656,12 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter sets the URL to SCAYT core. Required to switch to the licensed version of SCAYT application.\r
+ * Sets the URL to SCAYT core. Required to switch to the licensed version of SCAYT.\r
  *\r
- * Further details available at [http://wiki.webspellchecker.net/doku.php?id=migration:hosredfreetolicensedck](http://wiki.webspellchecker.net/doku.php?id=migration:hosredfreetolicensedck)\r
+ * Refer to [SCAYT documentation](http://wiki.webspellchecker.net/doku.php?id=migration:hosredfreetolicensedck)\r
+ * for more details.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
  *             config.scayt_srcUrl = "http://my-host/spellcheck/lf/scayt/scayt.js";\r
  *\r
@@ -1635,10 +1670,13 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter links SCAYT to custom dictionaries. This is a string containing dictionary IDs\r
+ * Links SCAYT to custom dictionaries. This is a string containing the dictionary IDs\r
  * separated by commas (`','`). Available only for the licensed version.\r
  *\r
- * Further details at [http://wiki.webspellchecker.net/doku.php?id=installationandconfiguration:customdictionaries:licensed](http://wiki.webspellchecker.net/doku.php?id=installationandconfiguration:customdictionaries:licensed)\r
+ * Refer to [SCAYT documentation](http://wiki.webspellchecker.net/doku.php?id=installationandconfiguration:customdictionaries:licensed)\r
+ * for more details.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
  *             config.scayt_customDictionaryIds = '3021,3456,3478';\r
  *\r
@@ -1647,9 +1685,14 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter activates a User Dictionary in SCAYT. The user\r
+ * Activates a User Dictionary in SCAYT. The user\r
  * dictionary name must be used. Available only for the licensed version.\r
  *\r
+ * Refer to [SCAYT documentation](http://wiki.webspellchecker.net/doku.php?id=installationandconfiguration:userdictionaries)\r
+ * for more details.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
+ *\r
  *             config.scayt_userDictionaryName = 'MyDictionary';\r
  *\r
  * @cfg {String} [scayt_userDictionaryName='']\r
@@ -1657,14 +1700,16 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter defines the order SCAYT context menu items by groups.\r
+ * Defines the order of SCAYT context menu items by groups.\r
  * This must be a string with one or more of the following\r
  * words separated by a pipe character (`'|'`):\r
  *\r
- * * `suggest` – main suggestion word list,\r
- * * `moresuggest` – more suggestions word list,\r
+ * * `suggest` – The main suggestion word list.\r
+ * * `moresuggest` – The "More suggestions" word list.\r
  * * `control` – SCAYT commands, such as "Ignore" and "Add Word".\r
  *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
+ *\r
  * Example:\r
  *\r
  *             config.scayt_contextMenuItemsOrder = 'moresuggest|control|suggest';\r
@@ -1674,9 +1719,11 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * If set to `true` – overrides checkDirty functionality of CK\r
- * to fix SCAYT issues with incorrect checkDirty behavior. If set to `false`,\r
- * provides better performance on big preloaded text.\r
+ * If set to `true`, it overrides the {@link CKEDITOR.editor#checkDirty checkDirty} functionality of CKEditor\r
+ * to fix SCAYT issues with incorrect `checkDirty` behavior. If set to `false`,\r
+ * it provides better performance on big preloaded text.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
  *             config.scayt_handleCheckDirty = 'false';\r
  *\r
@@ -1685,9 +1732,12 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * If set to `true` – overrides undo\redo functionality of CK\r
- * to fix SCAYT issues with incorrect undo\redo behavior. If set to `false`,\r
- * provides better performance on undo\redo text.\r
+ * Configures undo/redo behavior of SCAYT in CKEditor.\r
+ * If set to `true`, it overrides the undo/redo functionality of CKEditor\r
+ * to fix SCAYT issues with incorrect undo/redo behavior. If set to `false`,\r
+ * it provides better performance on text undo/redo.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
  *             config.scayt_handleUndoRedo = 'false';\r
  *\r
@@ -1696,62 +1746,81 @@ CKEDITOR.on('scaytReady', function() {
  */\r
 \r
 /**\r
- * The parameter that turns off\on 'ignore-all-caps-words' option by default\r
- * It may be needed to disableOptionStorage for this parameter, because optionStorage has higher priority.\r
+ * Enables the "Ignore All-Caps Words" option by default.\r
+ * You may need to {@link CKEDITOR.config#scayt_disableOptionsStorage disable option storing} for this setting to be\r
+ * effective because option storage has a higher priority.\r
  *\r
- *             config.scayt_ignoreAllCapsWords = false;\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
+ *             config.scayt_ignoreAllCapsWords = true;\r
+ *\r
+ * @since 4.5.6\r
  * @cfg {Boolean} [scayt_ignoreAllCapsWords=false]\r
  * @member CKEDITOR.config\r
  */\r
 \r
 /**\r
- * The parameter that turns off\on 'ignore-domain-names' option by default\r
- * It may be needed to disableOptionStorage for this parameter, because optionStorage has higher priority.\r
+ * Enables the "Ignore Domain Names" option by default.\r
+ * You may need to {@link CKEDITOR.config#scayt_disableOptionsStorage disable option storing} for this setting to be\r
+ * effective because option storage has a higher priority.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
- *             config.scayt_ignoreDomainNames = false;\r
+ *             config.scayt_ignoreDomainNames = true;\r
  *\r
+ * @since 4.5.6\r
  * @cfg {Boolean} [scayt_ignoreDomainNames=false]\r
  * @member CKEDITOR.config\r
  */\r
 \r
 /**\r
- * The parameter that turns off\on 'ignore-words-with-mixed-cases' option by default\r
- * It may be needed to disableOptionStorage for this parameter, because optionStorage has higher priority.\r
+ * Enables the "Ignore Words with Mixed Case" option by default.\r
+ * You may need to {@link CKEDITOR.config#scayt_disableOptionsStorage disable option storing} for this setting to be\r
+ * effective because option storage has a higher priority.\r
  *\r
- *             config.scayt_ignoreWordsWithMixedCases = false;\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
+ *             config.scayt_ignoreWordsWithMixedCases = true;\r
+ *\r
+ * @since 4.5.6\r
  * @cfg {Boolean} [scayt_ignoreWordsWithMixedCases=false]\r
  * @member CKEDITOR.config\r
  */\r
 \r
 /**\r
- * The parameter that turns off\on 'ignore-words-with-numbers' option by default\r
- * It may be needed to disableOptionStorage for this parameter, because optionStorage has higher priority.\r
+ * Enables the "Ignore Words with Numbers" option by default.\r
+ * You may need to {@link CKEDITOR.config#scayt_disableOptionsStorage disable option storing} for this setting to be\r
+ * effective because option storage has a higher priority.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
- *             config.scayt_ignoreWordsWithNumbers = false;\r
+ *             config.scayt_ignoreWordsWithNumbers = true;\r
  *\r
+ * @since 4.5.6\r
  * @cfg {Boolean} [scayt_ignoreWordsWithNumbers=false]\r
  * @member CKEDITOR.config\r
  */\r
 \r
 /**\r
- * Disabling of SCAYT Options storing during several sessions. Options storing will be turned off after page refresh.\r
+ * Disables storing of SCAYT options between sessions. Option storing will be turned off after a page refresh.\r
+ * The following settings can be used:\r
+ *\r
+ * * `'options'` – Disables storing of all SCAYT Ignore options.\r
+ * * `'ignore-all-caps-words'` – Disables storing of the "Ignore All-Caps Words" option.\r
+ * * `'ignore-domain-names'` – Disables storing of the "Ignore Domain Names" option.\r
+ * * `'ignore-words-with-mixed-cases'` – Disables storing of the "Ignore Words with Mixed Case" option.\r
+ * * `'ignore-words-with-numbers'` – Disables storing of the "Ignore Words with Numbers" option.\r
+ * * `'lang'` – Disables storing of the SCAYT spell check language.\r
+ * * `'all'` – Disables storing of all SCAYT options.\r
  *\r
- * * `'options'` - disables all SCAYT Ignore options\r
- * * `'ignore-all-caps-words'` - disables 'Ignore All-Caps Words' option\r
- * * `'ignore-domain-names'` - disables 'Ignore Domain Names' option\r
- * * `'ignore-words-with-mixed-cases'` - disables 'Ignore Words with Mixed Case' option\r
- * * `'ignore-words-with-numbers'` - disables 'Ignore Words with Numbers' option\r
- * * `'lang'` - disables SCAYT spell check language storing\r
- * * `'all'` - disables all SCAYT options storing\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
  * Example:\r
  *\r
- *             // One options disabling.\r
+ *             // Disabling one option.\r
  *             config.scayt_disableOptionsStorage = 'all';\r
  *\r
- *             // Several options disabling.\r
+ *             // Disabling several options.\r
  *     config.scayt_disableOptionsStorage = ['lang', 'ignore-domain-names', 'ignore-words-with-numbers'];\r
  *\r
  *\r
@@ -1759,9 +1828,11 @@ CKEDITOR.on('scaytReady', function() {
  * @member CKEDITOR.config\r
  */\r
 \r
- /**\r
+/**\r
  * Specifies the names of tags that will be skipped while spell checking. This is a string containing tag names\r
- * separated by commas (`','`). Please note that `'style'` tag would be added to specified tags list.\r
+ * separated by commas (`','`). Please note that the `'style'` tag would be added to specified tags list.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
  *             config.scayt_elementsToIgnore = 'del,pre';\r
  *\r
@@ -1769,8 +1840,10 @@ CKEDITOR.on('scaytReady', function() {
  * @member CKEDITOR.config\r
  */\r
 \r
- /**\r
- * The parameter turns on/off multi language support in SCAYT. If 'true', turns on SCAYT multi language support after loading the editor.\r
+/**\r
+ * Enables multi-language support in SCAYT. If set to `true`, turns on SCAYT multi-language support after loading the editor.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
  *             config.scayt_multiLanguageMode = true;\r
  *\r
@@ -1778,18 +1851,22 @@ CKEDITOR.on('scaytReady', function() {
  * @member CKEDITOR.config\r
  */\r
 \r
- /**\r
- * Defines additional styles for misspellings for specified languages. Styles will be applied only if 'scayt_multiLanguageMode' parameter is set to 'true'\r
- * and 'language' plugin included and loaded into editor.  All misspellings still will be underlined with red waveline by default.\r
+/**\r
+ * Defines additional styles for misspellings for specified languages. Styles will be applied only if\r
+ * the {@link CKEDITOR.config#scayt_multiLanguageMode} option is set to `true` and the [Language](http://ckeditor.com/addon/language)\r
+ * plugin is included and loaded in the editor. By default, all misspellings will still be underlined with the red waveline.\r
+ *\r
+ * Read more in the [documentation](#!/guide/dev_spellcheck) and see the [SDK sample](http://sdk.ckeditor.com/samples/spellchecker.html).\r
  *\r
  * Example:\r
  *\r
- *             // Display misspellings in French language with green color and underlined with red waveline\r
+ *             // Display misspellings in French language with green color and underlined with red waveline.\r
  *             config.scayt_multiLanguageStyles = {\r
  *                     'fr': 'color: green'\r
  *             };\r
  *\r
- *             // Display misspellings in Italian language with green color and underlined with red waveline and German misspellings with red color only\r
+ *             // Display misspellings in Italian language with green color and underlined with red waveline\r
+ *             // and German misspellings with red color only.\r
  *             config.scayt_multiLanguageStyles = {\r
  *                     'it': 'color: green',\r
  *                     'de': 'background-image: none; color: red'\r