Changeset 5155

Timestamp:

02/18/10 16:01:39 (3 years ago)

Author:

alfonsoml

Message:

Improve documentation (#5024)

Location:

CKEditor/trunk/_source/plugins

Files:

• basicstyles/plugin.js (modified) (1 diff)
• indent/plugin.js (modified) (1 diff)

CKEditor/trunk/_source/plugins/basicstyles/plugin.js

@@ -43 +43 @@
 
 // Basic Inline Styles.
+/**
+ * The style definition to be used to apply the bold style in the text.
+ * @type Object
+ * @example
+ * config.coreStyles_bold = { element : 'b', overrides : 'strong' };
+ * @example
+ * config.coreStyles_bold = { element : 'span', attributes : {'class': 'Bold'} };
+ */
 CKEDITOR.config.coreStyles_bold                 = { element : 'strong', overrides : 'b' };
+/**
+ * The style definition to be used to apply the italic style in the text.
+ * @type Object
+ * @default { element : 'em', overrides : 'i' }
+ * @example
+ * CKEDITOR.config.coreStyles_italic            = { element : 'span', attributes : {'class': 'Italic'} };
+ */
 CKEDITOR.config.coreStyles_italic               = { element : 'em', overrides : 'i' };
+/**
+ * The style definition to be used to apply the underline style in the text.
+ * @type Object
+ * @default { element : 'u' }
+ * @example
+ * CKEDITOR.config.coreStyles_underline = { element : 'span', attributes : {'class': 'Underline'}};
+ */
 CKEDITOR.config.coreStyles_underline    = { element : 'u' };
+/**
+ * The style definition to be used to apply the strike style in the text.
+ * @type Object
+ * @default { element : 'strike' }
+ * @example
+ * CKEDITOR.config.coreStyles_strike            = { element : 'span', attributes : {'class': 'StrikeThrough'}, overrides : 'strike' };
+ */
 CKEDITOR.config.coreStyles_strike               = { element : 'strike' };
+/**
+ * The style definition to be used to apply the subscript style in the text.
+ * @type Object
+ * @default { element : 'sub' }
+ * @example
+ * CKEDITOR.config.coreStyles_subscript = { element : 'span', attributes : {'class': 'Subscript'}, overrides : 'sub' };
+ */
 CKEDITOR.config.coreStyles_subscript    = { element : 'sub' };
+/**
+ * The style definition to be used to apply the superscript style in the text.
+ * @type Object
+ * @default { element : 'sup' }
+ * @example
+ * CKEDITOR.config.coreStyles_superscript       = { element : 'span', attributes : {'class': 'Superscript'}, overrides : 'sup' };
+ */
 CKEDITOR.config.coreStyles_superscript  = { element : 'sup' };

CKEditor/trunk/_source/plugins/indent/plugin.js

@@ -322 +322 @@
                 indentClasses : null
         });
+
+/**
+ * Size of each indentation step
+ * @type Number
+ * @default 40
+ * @example
+ * config.indentOffset = 4;
+ */
+
+ /**
+ * Unit for the indentation style
+ * @type String
+ * @default 'px'
+ * @example
+ * config.indentUnit = 'em';
+ */
+
+ /**
+ * List of classes to use for indenting the contents. If it's null, no classes will be used
+ * and instead the {@link #indentUnit} and {@link #indentOffset} properties will be used.
+ * @type Array
+ * default null
+ * @example
+ * // Use the classes 'Indent1', 'Indent2', 'Indent3'
+ * config.indentClasses = ['Indent1', 'Indent2', 'Indent3'];
+ */