Changeset 5155


Ignore:
Timestamp:
02/18/2010 04:01:39 PM (5 years ago)
Author:
alfonsoml
Message:

Improve documentation (#5024)

Location:
CKEditor/trunk/_source/plugins
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • CKEditor/trunk/_source/plugins/basicstyles/plugin.js

    r4858 r5155  
    4343
    4444// Basic Inline Styles.
     45/**
     46 * The style definition to be used to apply the bold style in the text.
     47 * @type Object
     48 * @example
     49 * config.coreStyles_bold = { element : 'b', overrides : 'strong' };
     50 * @example
     51 * config.coreStyles_bold = { element : 'span', attributes : {'class': 'Bold'} };
     52 */
    4553CKEDITOR.config.coreStyles_bold                 = { element : 'strong', overrides : 'b' };
     54/**
     55 * The style definition to be used to apply the italic style in the text.
     56 * @type Object
     57 * @default { element : 'em', overrides : 'i' }
     58 * @example
     59 * CKEDITOR.config.coreStyles_italic            = { element : 'span', attributes : {'class': 'Italic'} };
     60 */
    4661CKEDITOR.config.coreStyles_italic               = { element : 'em', overrides : 'i' };
     62/**
     63 * The style definition to be used to apply the underline style in the text.
     64 * @type Object
     65 * @default { element : 'u' }
     66 * @example
     67 * CKEDITOR.config.coreStyles_underline = { element : 'span', attributes : {'class': 'Underline'}};
     68 */
    4769CKEDITOR.config.coreStyles_underline    = { element : 'u' };
     70/**
     71 * The style definition to be used to apply the strike style in the text.
     72 * @type Object
     73 * @default { element : 'strike' }
     74 * @example
     75 * CKEDITOR.config.coreStyles_strike            = { element : 'span', attributes : {'class': 'StrikeThrough'}, overrides : 'strike' };
     76 */
    4877CKEDITOR.config.coreStyles_strike               = { element : 'strike' };
     78/**
     79 * The style definition to be used to apply the subscript style in the text.
     80 * @type Object
     81 * @default { element : 'sub' }
     82 * @example
     83 * CKEDITOR.config.coreStyles_subscript = { element : 'span', attributes : {'class': 'Subscript'}, overrides : 'sub' };
     84 */
    4985CKEDITOR.config.coreStyles_subscript    = { element : 'sub' };
     86/**
     87 * The style definition to be used to apply the superscript style in the text.
     88 * @type Object
     89 * @default { element : 'sup' }
     90 * @example
     91 * CKEDITOR.config.coreStyles_superscript       = { element : 'span', attributes : {'class': 'Superscript'}, overrides : 'sup' };
     92 */
    5093CKEDITOR.config.coreStyles_superscript  = { element : 'sup' };
  • CKEditor/trunk/_source/plugins/indent/plugin.js

    r5150 r5155  
    322322                indentClasses : null
    323323        });
     324
     325/**
     326 * Size of each indentation step
     327 * @type Number
     328 * @default 40
     329 * @example
     330 * config.indentOffset = 4;
     331 */
     332
     333 /**
     334 * Unit for the indentation style
     335 * @type String
     336 * @default 'px'
     337 * @example
     338 * config.indentUnit = 'em';
     339 */
     340
     341 /**
     342 * List of classes to use for indenting the contents. If it's null, no classes will be used
     343 * and instead the {@link #indentUnit} and {@link #indentOffset} properties will be used.
     344 * @type Array
     345 * default null
     346 * @example
     347 * // Use the classes 'Indent1', 'Indent2', 'Indent3'
     348 * config.indentClasses = ['Indent1', 'Indent2', 'Indent3'];
     349 */
Note: See TracChangeset for help on using the changeset viewer.
© 2003 – 2012 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy