Skip to content

Commit 2be32a2

Browse files
authored
Merge pull request ckeditor#13474 from ckeditor/ck/12704-cleanup-docs-for-select-all-plugin
Internal (select-all): Clean-up docs for `ckeditor5-select-all`. Closes ckeditor#12704 .
2 parents e2a615f + af449ca commit 2be32a2

File tree

4 files changed

+8
-16
lines changed

4 files changed

+8
-16
lines changed

packages/ckeditor5-select-all/src/selectall.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ import SelectAllUI from './selectallui';
1818
* and the {@link module:select-all/selectallui~SelectAllUI select all UI feature}.
1919
*
2020
* Please refer to the documentation of individual features to learn more.
21-
*
22-
* @extends module:core/plugin~Plugin
2321
*/
2422
export default class SelectAll extends Plugin {
2523
/**

packages/ckeditor5-select-all/src/selectallcommand.ts

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ import type { Element, Schema } from '@ckeditor/ckeditor5-engine';
2323
* If the selection was anchored in a {@glink framework/guides/tutorials/implementing-a-block-widget nested editable}
2424
* (e.g. a caption of an image), the new selection will contain its entire content. Successive executions of this command
2525
* will expand the selection to encompass more and more content up to the entire editable root of the editor.
26-
*
27-
* @extends module:core/command~Command
2826
*/
2927
export default class SelectAllCommand extends Command {
3028
/**
@@ -64,14 +62,14 @@ export default class SelectAllCommand extends Command {
6462
}
6563
}
6664

67-
// Checks whether the element is a valid select-all scope.
68-
// Returns true, if the element is a {@link module:engine/model/schema~Schema#isLimit limit},
69-
// and can contain any text or paragraph.
70-
//
71-
// @param {module:engine/model/schema~Schema} schema The schema to check against.
72-
// @param {module:engine/model/element~Element} element
73-
// @return {Boolean}
74-
function isSelectAllScope( schema: Schema, element: Element ) {
65+
/**
66+
* Checks whether the element is a valid select-all scope. Returns true, if the element is a
67+
* {@link module:engine/model/schema~Schema#isLimit limit}, and can contain any text or paragraph.
68+
*
69+
* @param schema Schema to check against.
70+
* @param element Model element.
71+
*/
72+
function isSelectAllScope( schema: Schema, element: Element ): boolean {
7573
return schema.isLimit( element ) && ( schema.checkChild( element, '$text' ) || schema.checkChild( element, 'paragraph' ) );
7674
}
7775

packages/ckeditor5-select-all/src/selectallediting.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ const SELECT_ALL_KEYSTROKE = parseKeystroke( 'Ctrl+A' );
1919
*
2020
* It registers the `'selectAll'` {@link module:select-all/selectallcommand~SelectAllCommand command}
2121
* and the <kbd>Ctrl/⌘</kbd>+<kbd>A</kbd> keystroke listener which executes it.
22-
*
23-
* @extends module:core/plugin~Plugin
2422
*/
2523
export default class SelectAllEditing extends Plugin {
2624
/**

packages/ckeditor5-select-all/src/selectallui.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ import selectAllIcon from '../theme/icons/select-all.svg';
1818
* It registers the `'selectAll'` UI button in the editor's
1919
* {@link module:ui/componentfactory~ComponentFactory component factory}. When clicked, the button
2020
* executes the {@link module:select-all/selectallcommand~SelectAllCommand select all command}.
21-
*
22-
* @extends module:core/plugin~Plugin
2321
*/
2422
export default class SelectAllUI extends Plugin {
2523
/**

0 commit comments

Comments
 (0)