Changeset 7022 for CKEditor/trunk

Timestamp:

06/08/11 16:44:32 (2 years ago)

Author:

garry.yao

Message:

JSDoc fill up for menu item registration APIs.

File:

• CKEditor/trunk/_source/plugins/menu/plugin.js (modified) (5 diffs)

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

@@ -15 +15 @@
                         groupsOrder[ groups[ i ] ] = i + 1;
 
+                /**
+                 * Register to the editor's context menu an item group for later association with menu items.
+                 * @name CKEDITOR.editor.prototype.addMenuGroup
+                 * @param {String} name Specify a group name.
+                 * @param {Number} [order=100]  Define the display sequence of this group inside menu, smaller value get displayed ahead.
+                 */
                 editor.addMenuGroup = function( name, order )
                         {
@@ -20 +26 @@
                         };
 
+                /**
+                 * Add to the editor's context menu an item from the specified definition.
+                 * @name CKEDITOR.editor.prototype.addMenuItem
+                 * @param {String} name The menu item name.
+                 * @param {CKEDITOR.menu.definition} definition  The menu item definition.
+                 */
                 editor.addMenuItem = function( name, definition )
                         {
@@ -26 +38 @@
                         };
 
+                /**
+                 * Add to the editor's context menu one or more items from the specified definition array.
+                 * @name CKEDITOR.editor.prototype.addMenuItems
+                 * @param {Array} definitions List of definitions for each of them as if {@link CKEDITOR.editor.addMenuItem} is called.
+                 */
                 editor.addMenuItems = function( definitions )
                         {
@@ -34 +51 @@
                         };
 
+                /**
+                 * Retrieve from the editor's context menu a particular menu item definition.
+                 * @name CKEDITOR.editor.prototype.getMenuItem
+                 * @param {String} name The name of the wanted menu item.
+                 * @return {CKEDITOR.menu.definition}
+                 */
                 editor.getMenuItem = function( name )
                         {
@@ -39 +62 @@
                         };
 
+                /**
+                 * Remove from the editor's context menu a particular menu item which was added before.
+                 * @name CKEDITOR.editor.prototype.removeMenuItem
+                 * @param {String} name The name of the wanted menu item.
+                 */
                 editor.removeMenuItem = function( name )
                         {