Skip to content

Commit

Permalink
Updated doc strings to conform to JSDuck 5.x.
Browse files Browse the repository at this point in the history
  • Loading branch information
Reinmar committed Jan 31, 2014
1 parent f53fc0b commit c793456
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 12 deletions.
19 changes: 17 additions & 2 deletions core/focusmanager.js
Expand Up @@ -54,13 +54,20 @@
var SLOT_NAME = 'focusmanager',
SLOT_NAME_LISTENERS = 'focusmanager_handlers';

/**
* Object used to hold private stuff.
*
* @private
* @class
* @singleton
*/
CKEDITOR.focusManager._ = {
/**
* The delay (in milliseconds) to deactivate the editor when UI dom element has lost focus.
*
* @private
* @static
* @property {Number} [_.blurDelay=200]
* @property {Number} [blurDelay=200]
* @member CKEDITOR.focusManager._
*/
blurDelay: 200
};
Expand All @@ -81,6 +88,7 @@
* editor.focusManage.focus( editor.editable() );
*
* @param {CKEDITOR.dom.element} [currentActive] The new value of {@link #currentActive} property.
* @member CKEDITOR.focusManager
*/
focus: function( currentActive ) {
if ( this._.timer )
Expand Down Expand Up @@ -108,13 +116,17 @@

/**
* Prevent from changing the focus manager state until next {@link #unlock} is called.
*
* @member CKEDITOR.focusManager
*/
lock: function() {
this._.locked = 1;
},

/**
* Restore the automatic focus management, if {@link #lock} is called.
*
* @member CKEDITOR.focusManager
*/
unlock: function() {
delete this._.locked;
Expand All @@ -132,6 +144,7 @@
* editor.focusManager.blur();
*
* @param {Boolean} [noDelay=false] Deactivate immediately the editor instance synchronously.
* @member CKEDITOR.focusManager
*/
blur: function( noDelay ) {
if ( this._.locked )
Expand Down Expand Up @@ -167,6 +180,7 @@
*
* @param {CKEDITOR.dom.element} element The container (top most) element of one UI part.
* @param {Boolean} isCapture If specified {@link CKEDITOR.event#useCapture} will be used when listening to the focus event.
* @member CKEDITOR.focusManager
*/
add: function( element, isCapture ) {
var fm = element.getCustomData( SLOT_NAME );
Expand Down Expand Up @@ -214,6 +228,7 @@
* Dismiss an element from the the focus manager delegations added by {@link #add}.
*
* @param {CKEDITOR.dom.element} element The element to be removed from the focusmanager.
* @member CKEDITOR.focusManager
*/
remove: function( element ) {
element.removeCustomData( SLOT_NAME );
Expand Down
2 changes: 1 addition & 1 deletion plugins/dialogui/plugin.js
Expand Up @@ -1064,7 +1064,7 @@ CKEDITOR.plugins.add( 'dialogui', {
/**
* Sets the state of the checkbox.
*
* @param {Boolean} `true` to tick the checkbox, `false` to untick it.
* @param {Boolean} checked `true` to tick the checkbox, `false` to untick it.
* @param {Boolean} noChangeEvent Internal commit, to supress `change` event on this element.
*/
setValue: function( checked, noChangeEvent ) {
Expand Down
11 changes: 4 additions & 7 deletions plugins/mathjax/plugin.js
Expand Up @@ -135,6 +135,7 @@

/**
* @private
* @singleton
* @class CKEDITOR.plugins.mathjax
*/
CKEDITOR.plugins.mathjax = {};
Expand All @@ -144,8 +145,7 @@
* because it is used in both the widget and the dialog window.
*
* @private
* @property CKEDITOR.plugins.mathjax.fixSrc
* @member CKEDITOR.plugins.mathjax
* @property {String} fixSrc
*/
CKEDITOR.plugins.mathjax.fixSrc =
// In Firefox src must exist and be different than about:blank to emit load event.
Expand All @@ -161,19 +161,17 @@
'javascript:void(0)';

/**
* Loading indicator image generated by preloaders.net.
* Loading indicator image generated by http://preloaders.net.
*
* @private
* @property CKEDITOR.plugins.mathjax.loadingIcon
* @member CKEDITOR.plugins.mathjax
* @property {String} loadingIcon
*/
CKEDITOR.plugins.mathjax.loadingIcon = CKEDITOR.plugins.get( 'mathjax' ).path + 'images/loader.gif';

/**
* Computes predefined styles and copies them to another element.
*
* @private
* @member CKEDITOR.plugins.mathjax
* @param {CKEDITOR.dom.element} from Copy source.
* @param {CKEDITOR.dom.element} to Copy target.
*/
Expand All @@ -192,7 +190,6 @@
* Trims MathJax value from '\(1+1=2\)' to '1+1=2'.
*
* @private
* @member CKEDITOR.plugins.mathjax
* @param {String} value String to trim.
* @returns {String} Trimed string.
*/
Expand Down
4 changes: 2 additions & 2 deletions plugins/richcombo/plugin.js
Expand Up @@ -428,9 +428,9 @@ CKEDITOR.plugins.add( 'richcombo', {
} );

/**
* @member CKEDITOR.ui
* @param {String}
* @param {String} name
* @param {Object} definition
* @member CKEDITOR.ui
* @todo
*/
CKEDITOR.ui.prototype.addRichCombo = function( name, definition ) {
Expand Down

0 comments on commit c793456

Please sign in to comment.