Ticket #5024: 5024.patch

File 5024.patch, 3.0 KB (added by Alfonso Martínez de Lizarrondo, 10 years ago)

Improved documentation

  • _source/plugins/basicstyles/plugin.js

     
    4242});
    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 * // This is actually the default value for it.
     50 * config.coreStyles_bold = { element : 'strong', overrides : 'b' };
     51 */
    4552CKEDITOR.config.coreStyles_bold                 = { element : 'strong', overrides : 'b' };
     53/**
     54 * The style definition to be used to apply the italic style in the text.
     55 * @type Object
     56 * @example
     57 * // This is actually the default value for it.
     58 * CKEDITOR.config.coreStyles_italic            = { element : 'em', overrides : 'i' };
     59 */
    4660CKEDITOR.config.coreStyles_italic               = { element : 'em', overrides : 'i' };
     61/**
     62 * The style definition to be used to apply the underline style in the text.
     63 * @type Object
     64 * @example
     65 * // This is actually the default value for it.
     66 * CKEDITOR.config.coreStyles_underline = { element : 'u' };
     67 */
    4768CKEDITOR.config.coreStyles_underline    = { element : 'u' };
     69/**
     70 * The style definition to be used to apply the strike style in the text.
     71 * @type Object
     72 * @example
     73 * // This is actually the default value for it.
     74 * CKEDITOR.config.coreStyles_strike            = { element : 'strike' };
     75 */
    4876CKEDITOR.config.coreStyles_strike               = { element : 'strike' };
     77/**
     78 * The style definition to be used to apply the subscript style in the text.
     79 * @type Object
     80 * @example
     81 * // This is actually the default value for it.
     82 * CKEDITOR.config.coreStyles_subscript = { element : 'sub' };
     83 */
    4984CKEDITOR.config.coreStyles_subscript    = { element : 'sub' };
     85/**
     86 * The style definition to be used to apply the superscript style in the text.
     87 * @type Object
     88 * @example
     89 * // This is actually the default value for it.
     90 * CKEDITOR.config.coreStyles_superscript       = { element : 'sup' };
     91 */
    5092CKEDITOR.config.coreStyles_superscript  = { element : 'sup' };
  • _source/plugins/indent/plugin.js

     
    321321                indentUnit : 'px',
    322322                indentClasses : null
    323323        });
     324
     325/**
     326 * Size of each indentation step
     327 * @type Number
     328 * @example
     329 * config.indentOffset = 40;
     330 */
     331
     332 /**
     333 * Unit for the indentation style
     334 * @type String
     335 * @example
     336 * config.indentUnit = 'px';
     337 */
     338
     339 /**
     340 * List of classes to use for indenting the contents.
     341 * @type Array
     342 * @example
     343 * // Don't use classes for indenting. (this is the default value)
     344 * config.indentClasses = null;
     345 * @example
     346 * // Use the classes 'Indent1', 'Indent2', 'Indent3'
     347 * config.indentClasses = ['Indent1', 'Indent2', 'Indent3'];
     348 */
     349 No newline at end of file
© 2003 – 2019 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy