Changeset 7022 for CKEditor/trunk


Ignore:
Timestamp:
06/08/11 16:44:32 (4 years ago)
Author:
garry.yao
Message:

JSDoc fill up for menu item registration APIs.

File:
1 edited

Legend:

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

    r6985 r7022  
    1515                        groupsOrder[ groups[ i ] ] = i + 1; 
    1616 
     17                /** 
     18                 * Register to the editor's context menu an item group for later association with menu items. 
     19                 * @name CKEDITOR.editor.prototype.addMenuGroup 
     20                 * @param {String} name Specify a group name. 
     21                 * @param {Number} [order=100]  Define the display sequence of this group inside menu, smaller value get displayed ahead. 
     22                 */ 
    1723                editor.addMenuGroup = function( name, order ) 
    1824                        { 
     
    2026                        }; 
    2127 
     28                /** 
     29                 * Add to the editor's context menu an item from the specified definition. 
     30                 * @name CKEDITOR.editor.prototype.addMenuItem 
     31                 * @param {String} name The menu item name. 
     32                 * @param {CKEDITOR.menu.definition} definition  The menu item definition. 
     33                 */ 
    2234                editor.addMenuItem = function( name, definition ) 
    2335                        { 
     
    2638                        }; 
    2739 
     40                /** 
     41                 * Add to the editor's context menu one or more items from the specified definition array. 
     42                 * @name CKEDITOR.editor.prototype.addMenuItems 
     43                 * @param {Array} definitions List of definitions for each of them as if {@link CKEDITOR.editor.addMenuItem} is called. 
     44                 */ 
    2845                editor.addMenuItems = function( definitions ) 
    2946                        { 
     
    3451                        }; 
    3552 
     53                /** 
     54                 * Retrieve from the editor's context menu a particular menu item definition. 
     55                 * @name CKEDITOR.editor.prototype.getMenuItem 
     56                 * @param {String} name The name of the wanted menu item. 
     57                 * @return {CKEDITOR.menu.definition} 
     58                 */ 
    3659                editor.getMenuItem = function( name ) 
    3760                        { 
     
    3962                        }; 
    4063 
     64                /** 
     65                 * Remove from the editor's context menu a particular menu item which was added before. 
     66                 * @name CKEDITOR.editor.prototype.removeMenuItem 
     67                 * @param {String} name The name of the wanted menu item. 
     68                 */ 
    4169                editor.removeMenuItem = function( name ) 
    4270                        { 
Note: See TracChangeset for help on using the changeset viewer.
© 2003 – 2012 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy