API docs.

ckeditor · Sep 3, 2019 · e1f7e8d · e1f7e8d
1 parent 3001b4e
commit e1f7e8d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/src/model/documentselection.js b/src/model/documentselection.js
@@ -233,14 +233,14 @@ export default class DocumentSelection {
 	}
 
 	/**
-	 * Gets elements of type "block" touched by the selection.
+	 * Gets elements of type {@link module:engine/model/schema~Schema#isBlock "block"} touched by the selection.
 	 *
 	 * This method's result can be used for example to apply block styling to all blocks covered by this selection.
 	 *
 	 * **Note:** `getSelectedBlocks()` returns blocks that are nested in other non-block elements
 	 * but will not return blocks nested in other blocks.
 	 *
-	 * In this case the function will return exactly all 3 paragraphs:
+	 * In this case the function will return exactly all 3 paragraphs (note: `<blockQuote>` is not a block itself):
 	 *
 	 *		<paragraph>[a</paragraph>
 	 *		<blockQuote>
@@ -252,7 +252,7 @@ export default class DocumentSelection {
 	 *
 	 *		<paragraph>[]a</paragraph>
 	 *
-	 *	In such scenario however, only blocks A, B & E will be returned as blocks C & D are nested in block B:
+	 * In such a scenario, however, only blocks A, B & E will be returned as blocks C & D are nested in block B:
 	 *
 	 *		[<blockA></blockA>
 	 *		<blockB>
@@ -261,7 +261,7 @@ export default class DocumentSelection {
 	 *		</blockB>
 	 *		<blockE></blockE>]
 	 *
-	 *	If the selection is inside a block all the inner blocks (A & B) are returned:
+	 * If the selection is inside a block all the inner blocks (A & B) are returned:
 	 *
 	 * 		<block>
 	 *			<blockA>[a</blockA>

diff --git a/src/model/selection.js b/src/model/selection.js
@@ -641,14 +641,14 @@ export default class Selection {
 	}
 
 	/**
-	 * Gets elements of type "block" touched by the selection.
+	 * Gets elements of type {@link module:engine/model/schema~Schema#isBlock "block"} touched by the selection.
 	 *
 	 * This method's result can be used for example to apply block styling to all blocks covered by this selection.
 	 *
 	 * **Note:** `getSelectedBlocks()` returns blocks that are nested in other non-block elements
 	 * but will not return blocks nested in other blocks.
 	 *
-	 * In this case the function will return exactly all 3 paragraphs:
+	 * In this case the function will return exactly all 3 paragraphs (note: `<blockQuote>` is not a block itself):
 	 *
 	 *		<paragraph>[a</paragraph>
 	 *		<blockQuote>
@@ -660,7 +660,7 @@ export default class Selection {
 	 *
 	 *		<paragraph>[]a</paragraph>
 	 *
-	 *	In such scenario however, only blocks A, B & E will be returned as blocks C & D are nested in block B:
+	 * In such a scenario, however, only blocks A, B & E will be returned as blocks C & D are nested in block B:
 	 *
 	 *		[<blockA></blockA>
 	 *		<blockB>
@@ -669,7 +669,7 @@ export default class Selection {
 	 *		</blockB>
 	 *		<blockE></blockE>]
 	 *
-	 *	If the selection is inside a block all the inner blocks (A & B) are returned:
+	 * If the selection is inside a block all the inner blocks (A & B) are returned:
 	 *
 	 * 		<block>
 	 *			<blockA>[a</blockA>