MDL-51228 atto_editor: Add documententation for inlineFormat flag

This commit is contained in:
Daniel Thies
2015-09-13 14:26:56 -05:00
parent 981379ffc2
commit 85cf55ebaf
3 changed files with 9 additions and 0 deletions
@@ -325,6 +325,7 @@ EditorPluginButtons.prototype = {
* specified, in the class for the button.
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @return {Node} The Node representing the newly created button.
*/
addButton: function(config) {
@@ -486,6 +487,7 @@ EditorPluginButtons.prototype = {
* specified, in the class for the button.
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @param {array} config.entries List of menu entries with the string (entry.text) and the handlers (entry.handler).
* @param {number} [config.overlayWidth=14] The width of the menu. This will be suffixed with the 'em' unit.
* @param {string} [config.menuColor] menu icon background color
@@ -672,6 +674,7 @@ EditorPluginButtons.prototype = {
* @param {object} config
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @param {object} [inheritFrom] A parent configuration that this configuration may inherit from.
* @return {object} The normalized configuration
* @private
@@ -325,6 +325,7 @@ EditorPluginButtons.prototype = {
* specified, in the class for the button.
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @return {Node} The Node representing the newly created button.
*/
addButton: function(config) {
@@ -484,6 +485,7 @@ EditorPluginButtons.prototype = {
* specified, in the class for the button.
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @param {array} config.entries List of menu entries with the string (entry.text) and the handlers (entry.handler).
* @param {number} [config.overlayWidth=14] The width of the menu. This will be suffixed with the 'em' unit.
* @param {string} [config.menuColor] menu icon background color
@@ -670,6 +672,7 @@ EditorPluginButtons.prototype = {
* @param {object} config
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @param {object} [inheritFrom] A parent configuration that this configuration may inherit from.
* @return {object} The normalized configuration
* @private
@@ -176,6 +176,7 @@ EditorPluginButtons.prototype = {
* specified, in the class for the button.
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @return {Node} The Node representing the newly created button.
*/
addButton: function(config) {
@@ -337,6 +338,7 @@ EditorPluginButtons.prototype = {
* specified, in the class for the button.
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @param {array} config.entries List of menu entries with the string (entry.text) and the handlers (entry.handler).
* @param {number} [config.overlayWidth=14] The width of the menu. This will be suffixed with the 'em' unit.
* @param {string} [config.menuColor] menu icon background color
@@ -523,6 +525,7 @@ EditorPluginButtons.prototype = {
* @param {object} config
* @param {function} config.callback A callback function to call when the button is clicked.
* @param {object} [config.callbackArgs] Any arguments to pass to the callback.
* @param {boolean} [config.inlineFormat] Delay callback for text input if selection is collapsed.
* @param {object} [inheritFrom] A parent configuration that this configuration may inherit from.
* @return {object} The normalized configuration
* @private