Skip to content

Commit ab16bc5

Browse files
committed
Docs: CKEditor 4.5 API corrections.
1 parent 884e43a commit ab16bc5

File tree

5 files changed

+127
-129
lines changed

5 files changed

+127
-129
lines changed

core/editable.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -271,8 +271,8 @@
271271
*
272272
* @param {String} data The HTML to be inserted.
273273
* @param {String} [mode='html'] See {@link CKEDITOR.editor#method-insertHtml}'s param.
274-
* @param {CKEDITOR.dom.range} [range] If specified the HTML will be inserted into the range
275-
* instead of into the selection. The selection will be placed at the end of insertion (like in the normal case).
274+
* @param {CKEDITOR.dom.range} [range] If specified, the HTML will be inserted into the range
275+
* instead of into the selection. The selection will be placed at the end of the insertion (like in the normal case).
276276
* Introduced in CKEditor 4.5.
277277
*/
278278
insertHtml: function( data, mode, range ) {
@@ -653,16 +653,16 @@
653653
},
654654

655655
/**
656-
* A base of the {@link CKEDITOR.editor#extractSelectedHtml} method.
656+
* The base of the {@link CKEDITOR.editor#extractSelectedHtml} method.
657657
*
658-
* **Note:** The range is modified so it matches desired selection after extraction.
659-
* But the selection is not made.
658+
* **Note:** The range is modified so it matches the desired selection after extraction
659+
* although the selection is not made.
660660
*
661661
* @since 4.5
662662
* @param {CKEDITOR.dom.range} range
663663
* @param {Boolean} [removeEmptyBlock=false] See {@link CKEDITOR.editor#extractSelectedHtml}'s parameter.
664664
* Note that the range will not be modified if this parameter is set to `true`.
665-
* @returns {CKEDITOR.dom.documentFragment} The extracted fragment of the editable contents.
665+
* @returns {CKEDITOR.dom.documentFragment} The extracted fragment of the editable content.
666666
*/
667667
extractHtmlFromRange: function( range, removeEmptyBlock ) {
668668
var helpers = extractHtmlFromRangeHelpers,

core/editor.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1031,7 +1031,7 @@
10311031
* CKEDITOR.instances.editor1.insertHtml( '<p>This is a new paragraph.</p>' );
10321032
*
10331033
* Fires the {@link #event-insertHtml} and {@link #event-afterInsertHtml} events. The HTML is inserted
1034-
* in {@link #event-insertHtml} event's listener with a default priority (10) so you can add listeners with
1034+
* in the {@link #event-insertHtml} event's listener with a default priority (10) so you can add listeners with
10351035
* lower or higher priorities in order to execute some code before or after the HTML is inserted.
10361036
*
10371037
* @param {String} html HTML code to be inserted into the editor.
@@ -1043,8 +1043,8 @@
10431043
* the selected position. This mode should be used when inserting "htmlified" plain text
10441044
* (HTML without inline styles and styling elements like `<b>`, `<strong>`, `<span style="...">`).
10451045
*
1046-
* @param {CKEDITOR.dom.range} [range] If specified the HTML will be inserted into the range
1047-
* instead of into the selection. The selection will be placed at the end of insertion (like in the normal case).
1046+
* @param {CKEDITOR.dom.range} [range] If specified, the HTML will be inserted into the range
1047+
* instead of into the selection. The selection will be placed at the end of the insertion (like in the normal case).
10481048
* Introduced in CKEditor 4.5.
10491049
*/
10501050
insertHtml: function( html, mode, range ) {
@@ -1126,7 +1126,7 @@
11261126

11271127
/**
11281128
* Gets the selected HTML (it is returned as a {@link CKEDITOR.dom.documentFragment document fragment}
1129-
* or a string) and removes the selected part of the DOM. This method is designed to work as user would
1129+
* or a string) and removes the selected part of the DOM. This method is designed to work as the user would
11301130
* expect the cut and delete functionalities to work.
11311131
*
11321132
* See also:
@@ -1136,9 +1136,9 @@
11361136
*
11371137
* @since 4.5
11381138
* @param {Boolean} [toString] If `true`, then a stringified HTML will be returned.
1139-
* @param {Boolean} [removeEmptyBlock=false] Default `false` means that the function will keep empty block (if the
1140-
* whole content was removed) or it will create it (if block element was removed) and set the selection in that block.
1141-
* If `true` the empty will be removed or not created. In this case the function will not handle the selection.
1139+
* @param {Boolean} [removeEmptyBlock=false] Default `false` means that the function will keep an empty block (if the
1140+
* entire content was removed) or it will create it (if a block element was removed) and set the selection in that block.
1141+
* If `true`, the empty block will be removed or not created. In this case the function will not handle the selection.
11421142
* @returns {CKEDITOR.dom.documentFragment/String/null}
11431143
*/
11441144
extractSelectedHtml: function( toString, removeEmptyBlock ) {

0 commit comments

Comments
 (0)