From cc9647ea23cb9e65a989d308ff13142a1da389f2 Mon Sep 17 00:00:00 2001 From: Tadeusz Piskozub Date: Mon, 7 Nov 2016 14:00:35 +0100 Subject: [PATCH] API docs corrections. --- core/editable.js | 2 +- core/editor.js | 8 ++++++++ plugins/pastefromword/filter/default.js | 5 +---- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/core/editable.js b/core/editable.js index 59a679a1099..4e88972a0b8 100644 --- a/core/editable.js +++ b/core/editable.js @@ -1232,7 +1232,7 @@ * * @method editable * @member CKEDITOR.editor - * @param {CKEDITOR.dom.element/CKEDITOR.editable} elementOrEditable The + * @param {CKEDITOR.dom.element/CKEDITOR.editable} [elementOrEditable] The * DOM element to become the editable or a {@link CKEDITOR.editable} object. */ CKEDITOR.editor.prototype.editable = function( element ) { diff --git a/core/editor.js b/core/editor.js index c38afa62a5b..7c47a205129 100644 --- a/core/editor.js +++ b/core/editor.js @@ -1836,6 +1836,14 @@ CKEDITOR.ELEMENT_MODE_INLINE = 3; * @param {CKEDITOR.editor} editor This editor instance. */ +/** + * Event fired when the {@link #method-destroy} is called, + * but before destroying the editor. + * + * @event beforeDestroy + * @param {CKEDITOR.editor} editor This editor instance. + */ + /** * Internal event to get the current data. * diff --git a/plugins/pastefromword/filter/default.js b/plugins/pastefromword/filter/default.js index 9e0262bb519..87a29583d60 100644 --- a/plugins/pastefromword/filter/default.js +++ b/plugins/pastefromword/filter/default.js @@ -1331,12 +1331,9 @@ * Note that list items within a single list but with different levels that did not get chopped * will still be rendered as a list tree later. * - * @todo: Describe what `lists` parameter is for. By the looks of it it's supposed to be array which is used - * to return the value. - * * @private * @param {CKEDITOR.htmlParser.element[]} list An array containing list items. - * @param {CKEDITOR.htmlParser.element[]} lists + * @param {CKEDITOR.htmlParser.element[]} lists All the lists in the pasted content represented by an array of arrays of list items. Modified by this method. * @member CKEDITOR.plugins.pastefromword.lists */ chopDiscontinousLists: function( list, lists ) {