vanilla ckeditor-3.1.1

[ckeditor.git] / _source / plugins / basicstyles / plugin.js

diff --git a/_source/plugins/basicstyles/plugin.js b/_source/plugins/basicstyles/plugin.js
index b44a766..cf64afc 100644 (file)
--- a/_source/plugins/basicstyles/plugin.js
+++ b/_source/plugins/basicstyles/plugin.js
@@ -42,9 +42,52 @@ CKEDITOR.plugins.add( 'basicstyles',
 });\r
 \r
 // Basic Inline Styles.\r
+/**\r
+ * The style definition to be used to apply the bold style in the text.\r
+ * @type Object\r
+ * @example\r
+ * config.coreStyles_bold = { element : 'b', overrides : 'strong' };\r
+ * @example\r
+ * config.coreStyles_bold = { element : 'span', attributes : {'class': 'Bold'} };\r
+ */\r
 CKEDITOR.config.coreStyles_bold                        = { element : 'strong', overrides : 'b' };\r
+/**\r
+ * The style definition to be used to apply the italic style in the text.\r
+ * @type Object\r
+ * @default { element : 'em', overrides : 'i' }\r
+ * @example\r
+ * CKEDITOR.config.coreStyles_italic           = { element : 'span', attributes : {'class': 'Italic'} };\r
+ */\r
 CKEDITOR.config.coreStyles_italic              = { element : 'em', overrides : 'i' };\r
+/**\r
+ * The style definition to be used to apply the underline style in the text.\r
+ * @type Object\r
+ * @default { element : 'u' }\r
+ * @example\r
+ * CKEDITOR.config.coreStyles_underline        = { element : 'span', attributes : {'class': 'Underline'}};\r
+ */\r
 CKEDITOR.config.coreStyles_underline   = { element : 'u' };\r
+/**\r
+ * The style definition to be used to apply the strike style in the text.\r
+ * @type Object\r
+ * @default { element : 'strike' }\r
+ * @example\r
+ * CKEDITOR.config.coreStyles_strike           = { element : 'span', attributes : {'class': 'StrikeThrough'}, overrides : 'strike' };\r
+ */\r
 CKEDITOR.config.coreStyles_strike              = { element : 'strike' };\r
+/**\r
+ * The style definition to be used to apply the subscript style in the text.\r
+ * @type Object\r
+ * @default { element : 'sub' }\r
+ * @example\r
+ * CKEDITOR.config.coreStyles_subscript        = { element : 'span', attributes : {'class': 'Subscript'}, overrides : 'sub' };\r
+ */\r
 CKEDITOR.config.coreStyles_subscript   = { element : 'sub' };\r
+/**\r
+ * The style definition to be used to apply the superscript style in the text.\r
+ * @type Object\r
+ * @default { element : 'sup' }\r
+ * @example\r
+ * CKEDITOR.config.coreStyles_superscript      = { element : 'span', attributes : {'class': 'Superscript'}, overrides : 'sup' };\r
+ */\r
 CKEDITOR.config.coreStyles_superscript = { element : 'sup' };\r