Changeset 6814 for CKEditor/trunk


Ignore:
Timestamp:
04/29/2011 02:56:51 PM (4 years ago)
Author:
Saare
Message:

Documentation enhancements.

Location:
CKEditor/trunk/_source
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • CKEditor/trunk/_source/core/plugindefinition.js

    r6348 r6814  
    2828 * { 
    2929 *     requires : [ 'button', 'selection' ] 
     30 * }); 
     31 */ 
     32 
     33/** 
     34 * A list of language files available for this plugin. These files are stored inside  
     35 * the "lang" directory, which is inside the plugin directory, follow the name  
     36 * pattern of "langCode.js", and contain a language definition created with {@link CKEDITOR.pluginDefinition#setLang}. 
     37 * While the plugin is being loaded, the editor checks this list to see if 
     38 * a language file of the current editor language ({@link CKEDITOR.editor#langCode})  
     39 * is available, and if so, loads it. Otherwise, the file represented by the first list item 
     40 * in the list is loaded. 
     41 * @name CKEDITOR.pluginDefinition.prototype.lang 
     42 * @type Array 
     43 * @example 
     44 * CKEDITOR.plugins.add( 'sample', 
     45 * { 
     46 *     lang : [ 'en', 'fr' ] 
    3047 * }); 
    3148 */ 
  • CKEditor/trunk/_source/core/plugins.js

    r6469 r6814  
    7777        }); 
    7878 
     79/** 
     80 * Loads a specific language file, or auto detect it. A callback is 
     81 * then called when the file gets loaded. 
     82 * @param {String} pluginName The name of the plugin to which the provided translation 
     83 *              should be attached. 
     84 * @param {String} languageCode The code of the language translation provided. 
     85 * @param {Object} languageEntries An object that contains pairs of label and 
     86 *              the respective translation. 
     87 * @example 
     88 * CKEDITOR.plugins.setLang( 'myPlugin', 'en', { 
     89 *      title : 'My plugin', 
     90 *      selectOption : 'Please select an option' 
     91 * } ); 
     92 */ 
    7993CKEDITOR.plugins.setLang = function( pluginName, languageCode, languageEntries ) 
    8094{ 
  • CKEditor/trunk/_source/plugins/button/plugin.js

    r6348 r6814  
    276276/** 
    277277 * Adds a button definition to the UI elements list. 
    278  * @param {String} The button name. 
    279  * @param {Object} The button definition. 
     278 * @param {String} name The button name. 
     279 * @param {Object} definition The button definition. 
    280280 * @example 
    281281 * editorInstance.ui.addButton( 'MyBold', 
Note: See TracChangeset for help on using the changeset viewer.
© 2003 – 2012 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy