vanilla ckeditor-3.5.4

[ckeditor.git] / _source / core / plugindefinition.js

diff --git a/_source/core/plugindefinition.js b/_source/core/plugindefinition.js
index e75bc4a..d9dc526 100644 (file)
--- a/_source/core/plugindefinition.js
+++ b/_source/core/plugindefinition.js
@@ -30,6 +30,23 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * });\r
  */\r
 \r
+/**\r
+ * A list of language files available for this plugin. These files are stored inside\r
+ * the "lang" directory, which is inside the plugin directory, follow the name\r
+ * pattern of "langCode.js", and contain a language definition created with {@link CKEDITOR.pluginDefinition#setLang}.\r
+ * While the plugin is being loaded, the editor checks this list to see if\r
+ * a language file of the current editor language ({@link CKEDITOR.editor#langCode})\r
+ * is available, and if so, loads it. Otherwise, the file represented by the first list item\r
+ * in the list is loaded.\r
+ * @name CKEDITOR.pluginDefinition.prototype.lang\r
+ * @type Array\r
+ * @example\r
+ * CKEDITOR.plugins.add( 'sample',\r
+ * {\r
+ *     lang : [ 'en', 'fr' ]\r
+ * });\r
+ */\r
+\r
  /**\r
  * Function called on initialization of every editor instance created in the\r
  * page before the init() call task. The beforeInit function will be called for\r