From e1f7e8dbe8664937a1b799637b070240b0406f2e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Tue, 3 Sep 2019 13:22:20 +0200 Subject: [PATCH] API docs. --- src/model/documentselection.js | 8 ++++---- src/model/selection.js | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index c52feb864..01daeaa06 100644 --- 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: `
` is not a block itself): * * [a *
@@ -252,7 +252,7 @@ export default class DocumentSelection { * * []a * - * 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: * * [ * @@ -261,7 +261,7 @@ export default class DocumentSelection { * * ] * - * 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: * * * [a diff --git a/src/model/selection.js b/src/model/selection.js index 8a20993d2..11ce80365 100644 --- 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: `
` is not a block itself): * * [a *
@@ -660,7 +660,7 @@ export default class Selection { * * []a * - * 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: * * [ * @@ -669,7 +669,7 @@ export default class Selection { * * ] * - * 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: * * * [a