vanilla ckeditor-3.4.2

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

diff --git a/_source/core/config.js b/_source/core/config.js
index f18c50b..a408d93 100644 (file)
--- a/_source/core/config.js
+++ b/_source/core/config.js
@@ -8,19 +8,34 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * default configuration settings.\r
  */\r
 \r
+/**\r
+ * Used in conjuction with {@link CKEDITOR.config.enterMode} and\r
+ * {@link CKEDITOR.config.shiftEnterMode} to make the editor produce <p>\r
+ * tags when using the ENTER key.\r
+ * @constant\r
+ */\r
 CKEDITOR.ENTER_P       = 1;\r
+\r
+/**\r
+ * Used in conjuction with {@link CKEDITOR.config.enterMode} and\r
+ * {@link CKEDITOR.config.shiftEnterMode} to make the editor produce <br>\r
+ * tags when using the ENTER key.\r
+ * @constant\r
+ */\r
 CKEDITOR.ENTER_BR      = 2;\r
+\r
+/**\r
+ * Used in conjuction with {@link CKEDITOR.config.enterMode} and\r
+ * {@link CKEDITOR.config.shiftEnterMode} to make the editor produce <div>\r
+ * tags when using the ENTER key.\r
+ * @constant\r
+ */\r
 CKEDITOR.ENTER_DIV     = 3;\r
 \r
 /**\r
- * Holds the default configuration settings. Changes to this object are\r
+ * @namespace Holds the default configuration settings. Changes to this object are\r
  * reflected in all editor instances, if not specificaly specified for those\r
  * instances.\r
- * @namespace\r
- * @example\r
- * // All editor created after the following setting will not load custom\r
- * // configuration files.\r
- * CKEDITOR.config.customConfig = '';\r
  */\r
 CKEDITOR.config =\r
 {\r
@@ -56,7 +71,7 @@ CKEDITOR.config =
         * The base href URL used to resolve relative and absolute URLs in the\r
         * editor content.\r
         * @type String\r
-        * @default '' (empty string)\r
+        * @default '' (empty)\r
         * @example\r
         * config.baseHref = 'http://www.example.com/path/';\r
         */\r
@@ -194,19 +209,29 @@ CKEDITOR.config =
 \r
        /**\r
         * Sets the "id" attribute to be used on the body element of the editing\r
-        * area.\r
+        * area. This can be useful when reusing the original CSS file you're using\r
+        * on your live website and you want to assing to the editor the same id\r
+        * you're using for the region that'll hold the contents. In this way,\r
+        * id specific CSS rules will be enabled.\r
         * @since 3.1\r
         * @type String\r
-        * @default ''\r
+        * @default '' (empty)\r
+        * @example\r
+        * config.bodyId = 'contents_id';\r
         */\r
        bodyId : '',\r
 \r
        /**\r
         * Sets the "class" attribute to be used on the body element of the editing\r
-        * area.\r
+        * area. This can be useful when reusing the original CSS file you're using\r
+        * on your live website and you want to assing to the editor the same class\r
+        * name you're using for the region that'll hold the contents. In this way,\r
+        * class specific CSS rules will be enabled.\r
         * @since 3.1\r
         * @type String\r
-        * @default ''\r
+        * @default '' (empty)\r
+        * @example\r
+        * config.bodyClass = 'contents';\r
         */\r
        bodyClass : '',\r
 \r
@@ -387,10 +412,10 @@ CKEDITOR.config =
 };\r
 \r
 /**\r
- * Indicates that some of the editor features, like alignement and text\r
+ * Indicates that some of the editor features, like alignment and text\r
  * direction, should used the "computed value" of the feature to indicate it's\r
- * on/off state, instead of using the "real value".\r
- *\r
+ * on/off state, instead of using the "real value".<br />\r
+ * <br />\r
  * If enabled, in a left to right written document, the "Left Justify"\r
  * alignment button will show as active, even if the aligment style is not\r
  * explicitly applied to the current paragraph in the editor.\r