Skip to content

Commit

Permalink
API docs fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
Reinmar committed Feb 27, 2015
1 parent 4eb3bf4 commit 4219fc6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
13 changes: 8 additions & 5 deletions src/ckeditor.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ CKEDITOR.define( [ 'editor', 'mvc/collection', 'promise' ], function( Editor, Co
var CKEDITOR = {
/**
* A collection containing all editor instances created.
*
* @readonly
* @property {Collection}
*/
instances: new Collection(),

Expand All @@ -27,13 +30,13 @@ CKEDITOR.define( [ 'editor', 'mvc/collection', 'promise' ], function( Editor, Co
* The creation of editor instances is an asynchronous operation, therefore a promise is returned by this
* method.
*
* CKEDITOR.create( '#content' );
* CKEDITOR.create( '#content' );
*
* CKEDITOR.create( '#content' ).then( function( editor ) {
* // Manipulate "editor" here.
* } );
* CKEDITOR.create( '#content' ).then( function( editor ) {
* // Manipulate "editor" here.
* } );
*
* @param {String|Object} element An element selector or a DOM element, which will be the source for the
* @param {String|HTMLElement} element An element selector or a DOM element, which will be the source for the
* created instance.
* @returns {Promise} A promise, which will be fulfilled with the created editor.
*/
Expand Down
4 changes: 2 additions & 2 deletions src/editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ CKEDITOR.define( [ 'ckeditor', 'mvc/model', 'utils' ], function( CKEDITOR, Model
* This constructor should be rarely used. When creating new editor instance use instead the
* {@link CKEDITOR#create CKEDITOR.create() method}.
*
* @param {Object} element The DOM element that will be the source for the created editor.
* @param {HTMLElement} element The DOM element that will be the source for the created editor.
* @constructor
*/
constructor: function Editor( element ) {
Expand All @@ -28,7 +28,7 @@ CKEDITOR.define( [ 'ckeditor', 'mvc/model', 'utils' ], function( CKEDITOR, Model
* editor creation and is not subject to be modified.
*
* @readonly
* @property {Object}
* @property {HTMLElement}
*/
this.element = element;
},
Expand Down

0 comments on commit 4219fc6

Please sign in to comment.