@ckeditor/ckeditor5-basic-styles 41.4.2 → 42.0.0-alpha.0

package/dist/index.js

@@ -6,35 +6,53 @@ import { Command, Plugin, icons } from '@ckeditor/ckeditor5-core/dist/index.js';
 import { ButtonView, MenuBarMenuListItemButtonView } from '@ckeditor/ckeditor5-ui/dist/index.js';
 import { TwoStepCaretMovement, inlineHighlight } from '@ckeditor/ckeditor5-typing/dist/index.js';
 
-class AttributeCommand extends Command {
+/**
+ * An extension of the base {@link module:core/command~Command} class, which provides utilities for a command
+ * that toggles a single attribute on a text or an element.
+ *
+ * `AttributeCommand` uses {@link module:engine/model/document~Document#selection}
+ * to decide which nodes (if any) should be changed, and applies or removes the attribute from them.
+ *
+ * The command checks the {@link module:engine/model/model~Model#schema} to decide if it can be enabled
+ * for the current selection and to which nodes the attribute can be applied.
+ */ class AttributeCommand extends Command {
+    /**
+	 * The attribute that will be set by the command.
+	 */ attributeKey;
+    /**
+	 * @param attributeKey Attribute that will be set by the command.
+	 */ constructor(editor, attributeKey){
+        super(editor);
+        this.attributeKey = attributeKey;
+    }
     /**
-     * Updates the command's {@link #value} and {@link #isEnabled} based on the current selection.
-     */ refresh() {
+	 * Updates the command's {@link #value} and {@link #isEnabled} based on the current selection.
+	 */ refresh() {
         const model = this.editor.model;
         const doc = model.document;
         this.value = this._getValueFromFirstAllowedNode();
         this.isEnabled = model.schema.checkAttributeInSelection(doc.selection, this.attributeKey);
     }
     /**
-     * Executes the command – applies the attribute to the selection or removes it from the selection.
-     *
-     * If the command is active (`value == true`), it will remove attributes. Otherwise, it will set attributes.
-     *
-     * The execution result differs, depending on the {@link module:engine/model/document~Document#selection}:
-     *
-     * * If the selection is on a range, the command applies the attribute to all nodes in that range
-     * (if they are allowed to have this attribute by the {@link module:engine/model/schema~Schema schema}).
-     * * If the selection is collapsed in a non-empty node, the command applies the attribute to the
-     * {@link module:engine/model/document~Document#selection} itself (note that typed characters copy attributes from the selection).
-     * * If the selection is collapsed in an empty node, the command applies the attribute to the parent node of the selection (note
-     * that the selection inherits all attributes from a node if it is in an empty node).
-     *
-     * @fires execute
-     * @param options Command options.
-     * @param options.forceValue If set, it will force the command behavior. If `true`,
-     * the command will apply the attribute, otherwise the command will remove the attribute.
-     * If not set, the command will look for its current value to decide what it should do.
-     */ execute(options = {}) {
+	 * Executes the command – applies the attribute to the selection or removes it from the selection.
+	 *
+	 * If the command is active (`value == true`), it will remove attributes. Otherwise, it will set attributes.
+	 *
+	 * The execution result differs, depending on the {@link module:engine/model/document~Document#selection}:
+	 *
+	 * * If the selection is on a range, the command applies the attribute to all nodes in that range
+	 * (if they are allowed to have this attribute by the {@link module:engine/model/schema~Schema schema}).
+	 * * If the selection is collapsed in a non-empty node, the command applies the attribute to the
+	 * {@link module:engine/model/document~Document#selection} itself (note that typed characters copy attributes from the selection).
+	 * * If the selection is collapsed in an empty node, the command applies the attribute to the parent node of the selection (note
+	 * that the selection inherits all attributes from a node if it is in an empty node).
+	 *
+	 * @fires execute
+	 * @param options Command options.
+	 * @param options.forceValue If set, it will force the command behavior. If `true`,
+	 * the command will apply the attribute, otherwise the command will remove the attribute.
+	 * If not set, the command will look for its current value to decide what it should do.
+	 */ execute(options = {}) {
         const model = this.editor.model;
         const doc = model.document;
         const selection = doc.selection;
@@ -59,11 +77,11 @@ class AttributeCommand extends Command {
         });
     }
     /**
-     * Checks the attribute value of the first node in the selection that allows the attribute.
-     * For the collapsed selection returns the selection attribute.
-     *
-     * @returns The attribute value.
-     */ _getValueFromFirstAllowedNode() {
+	 * Checks the attribute value of the first node in the selection that allows the attribute.
+	 * For the collapsed selection returns the selection attribute.
+	 *
+	 * @returns The attribute value.
+	 */ _getValueFromFirstAllowedNode() {
         const model = this.editor.model;
         const schema = model.schema;
         const selection = model.document.selection;
@@ -79,24 +97,23 @@ class AttributeCommand extends Command {
         }
         return false;
     }
-    /**
-     * @param attributeKey Attribute that will be set by the command.
-     */ constructor(editor, attributeKey){
-        super(editor);
-        this.attributeKey = attributeKey;
-    }
 }
 
 const BOLD$1 = 'bold';
-class BoldEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */ static get pluginName() {
+/**
+ * The bold editing feature.
+ *
+ * It registers the `'bold'` command and introduces the `bold` attribute in the model which renders to the view
+ * as a `<strong>` element.
+ */ class BoldEditing extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'BoldEditing';
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         const t = this.editor.t;
         // Allow bold attribute on text nodes.
@@ -151,6 +168,8 @@ class BoldEditing extends Plugin {
  * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */ /**
+ * @module basic-styles/utils
+ */ /**
  * Returns a function that creates a (toolbar or menu bar) button for a basic style feature.
  */ function getButtonCreator({ editor, commandName, plugin, icon, label, keystroke }) {
     return (ButtonClass)=>{
@@ -173,15 +192,17 @@ class BoldEditing extends Plugin {
 }
 
 const BOLD = 'bold';
-class BoldUI extends Plugin {
+/**
+ * The bold UI feature. It introduces the Bold button.
+ */ class BoldUI extends Plugin {
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'BoldUI';
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         const t = editor.locale.t;
         const command = editor.commands.get(BOLD);
@@ -208,40 +229,53 @@ class BoldUI extends Plugin {
     }
 }
 
-class Bold extends Plugin {
-    /**
-     * @inheritDoc
-     */ static get requires() {
+/**
+ * The bold feature.
+ *
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
+ * and the {@glink api/basic-styles package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:basic-styles/bold/boldediting~BoldEditing bold editing feature}
+ * and {@link module:basic-styles/bold/boldui~BoldUI bold UI feature}.
+ */ class Bold extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get requires() {
         return [
             BoldEditing,
             BoldUI
         ];
     }
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'Bold';
     }
 }
 
 const CODE$1 = 'code';
 const HIGHLIGHT_CLASS = 'ck-code_selected';
-class CodeEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */ static get pluginName() {
+/**
+ * The code editing feature.
+ *
+ * It registers the `'code'` command and introduces the `code` attribute in the model which renders to the view
+ * as a `<code>` element.
+ */ class CodeEditing extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'CodeEditing';
     }
     /**
-     * @inheritDoc
-     */ static get requires() {
+	 * @inheritDoc
+	 */ static get requires() {
         return [
             TwoStepCaretMovement
         ];
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         const t = this.editor.t;
         // Allow code attribute on text nodes.
@@ -291,15 +325,17 @@ class CodeEditing extends Plugin {
 var codeIcon = "<svg viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"m12.5 5.7 5.2 3.9v1.3l-5.6 4c-.1.2-.3.2-.5.2-.3-.1-.6-.7-.6-1l.3-.4 4.7-3.5L11.5 7l-.2-.2c-.1-.3-.1-.6 0-.8.2-.2.5-.4.8-.4a.8.8 0 0 1 .4.1zm-5.2 0L2 9.6v1.3l5.6 4c.1.2.3.2.5.2.3-.1.7-.7.6-1 0-.1 0-.3-.2-.4l-5-3.5L8.2 7l.2-.2c.1-.3.1-.6 0-.8-.2-.2-.5-.4-.8-.4a.8.8 0 0 0-.3.1z\"/></svg>";
 
 const CODE = 'code';
-class CodeUI extends Plugin {
+/**
+ * The code UI feature. It introduces the Code button.
+ */ class CodeUI extends Plugin {
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'CodeUI';
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         const t = editor.locale.t;
         const createButton = getButtonCreator({
@@ -326,32 +362,45 @@ class CodeUI extends Plugin {
     }
 }
 
-class Code extends Plugin {
-    /**
-     * @inheritDoc
-     */ static get requires() {
+/**
+ * The code feature.
+ *
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
+ * and the {@glink api/basic-styles package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:basic-styles/code/codeediting~CodeEditing code editing feature}
+ * and {@link module:basic-styles/code/codeui~CodeUI code UI feature}.
+ */ class Code extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get requires() {
         return [
             CodeEditing,
             CodeUI
         ];
     }
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'Code';
     }
 }
 
 const ITALIC$1 = 'italic';
-class ItalicEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */ static get pluginName() {
+/**
+ * The italic editing feature.
+ *
+ * It registers the `'italic'` command, the <kbd>Ctrl+I</kbd> keystroke and introduces the `italic` attribute in the model
+ * which renders to the view as an `<i>` element.
+ */ class ItalicEditing extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'ItalicEditing';
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         const t = this.editor.t;
         // Allow italic attribute on text nodes.
@@ -393,15 +442,17 @@ class ItalicEditing extends Plugin {
 var italicIcon = "<svg viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"m9.586 14.633.021.004c-.036.335.095.655.393.962.082.083.173.15.274.201h1.474a.6.6 0 1 1 0 1.2H5.304a.6.6 0 0 1 0-1.2h1.15c.474-.07.809-.182 1.005-.334.157-.122.291-.32.404-.597l2.416-9.55a1.053 1.053 0 0 0-.281-.823 1.12 1.12 0 0 0-.442-.296H8.15a.6.6 0 0 1 0-1.2h6.443a.6.6 0 1 1 0 1.2h-1.195c-.376.056-.65.155-.823.296-.215.175-.423.439-.623.79l-2.366 9.347z\"/></svg>";
 
 const ITALIC = 'italic';
-class ItalicUI extends Plugin {
+/**
+ * The italic UI feature. It introduces the Italic button.
+ */ class ItalicUI extends Plugin {
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'ItalicUI';
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         const command = editor.commands.get(ITALIC);
         const t = editor.locale.t;
@@ -428,32 +479,46 @@ class ItalicUI extends Plugin {
     }
 }
 
-class Italic extends Plugin {
-    /**
-     * @inheritDoc
-     */ static get requires() {
+/**
+ * The italic feature.
+ *
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
+ * and the {@glink api/basic-styles package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:basic-styles/italic/italicediting~ItalicEditing} and
+ * {@link module:basic-styles/italic/italicui~ItalicUI} plugins.
+ */ class Italic extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get requires() {
         return [
             ItalicEditing,
             ItalicUI
         ];
     }
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'Italic';
     }
 }
 
 const STRIKETHROUGH$1 = 'strikethrough';
-class StrikethroughEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */ static get pluginName() {
+/**
+ * The strikethrough editing feature.
+ *
+ * It registers the `'strikethrough'` command, the <kbd>Ctrl+Shift+X</kbd> keystroke and introduces the
+ * `strikethroughsthrough` attribute in the model which renders to the view
+ * as a `<s>` element.
+ */ class StrikethroughEditing extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'StrikethroughEditing';
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         const t = this.editor.t;
         // Allow strikethrough attribute on text nodes.
@@ -496,15 +561,17 @@ class StrikethroughEditing extends Plugin {
 var strikethroughIcon = "<svg viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M7 16.4c-.8-.4-1.5-.9-2.2-1.5a.6.6 0 0 1-.2-.5l.3-.6h1c1 1.2 2.1 1.7 3.7 1.7 1 0 1.8-.3 2.3-.6.6-.4.6-1.2.6-1.3.2-1.2-.9-2.1-.9-2.1h2.1c.3.7.4 1.2.4 1.7v.8l-.6 1.2c-.6.8-1.1 1-1.6 1.2a6 6 0 0 1-2.4.6c-1 0-1.8-.3-2.5-.6zM6.8 9 6 8.3c-.4-.5-.5-.8-.5-1.6 0-.7.1-1.3.5-1.8.4-.6 1-1 1.6-1.3a6.3 6.3 0 0 1 4.7 0 4 4 0 0 1 1.7 1l.3.7c0 .1.2.4-.2.7-.4.2-.9.1-1 0a3 3 0 0 0-1.2-1c-.4-.2-1-.3-2-.4-.7 0-1.4.2-2 .6-.8.6-1 .8-1 1.5 0 .8.5 1 1.2 1.5.6.4 1.1.7 1.9 1H6.8z\"/><path d=\"M3 10.5V9h14v1.5z\"/></svg>";
 
 const STRIKETHROUGH = 'strikethrough';
-class StrikethroughUI extends Plugin {
+/**
+ * The strikethrough UI feature. It introduces the Strikethrough button.
+ */ class StrikethroughUI extends Plugin {
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'StrikethroughUI';
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         const t = editor.locale.t;
         const createButton = getButtonCreator({
@@ -532,32 +599,45 @@ class StrikethroughUI extends Plugin {
     }
 }
 
-class Strikethrough extends Plugin {
-    /**
-     * @inheritDoc
-     */ static get requires() {
+/**
+ * The strikethrough feature.
+ *
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
+ * and the {@glink api/basic-styles package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:basic-styles/strikethrough/strikethroughediting~StrikethroughEditing} and
+ * {@link module:basic-styles/strikethrough/strikethroughui~StrikethroughUI} plugins.
+ */ class Strikethrough extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get requires() {
         return [
             StrikethroughEditing,
             StrikethroughUI
         ];
     }
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'Strikethrough';
     }
 }
 
 const SUBSCRIPT$1 = 'subscript';
-class SubscriptEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */ static get pluginName() {
+/**
+ * The subscript editing feature.
+ *
+ * It registers the `sub` command and introduces the `sub` attribute in the model which renders to the view
+ * as a `<sub>` element.
+ */ class SubscriptEditing extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'SubscriptEditing';
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         // Allow sub attribute on text nodes.
         editor.model.schema.extend('$text', {
@@ -587,15 +667,17 @@ class SubscriptEditing extends Plugin {
 var subscriptIcon = "<svg viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"m7.03 10.349 3.818-3.819a.8.8 0 1 1 1.132 1.132L8.16 11.48l3.819 3.818a.8.8 0 1 1-1.132 1.132L7.03 12.61l-3.818 3.82a.8.8 0 1 1-1.132-1.132L5.9 11.48 2.08 7.662A.8.8 0 1 1 3.212 6.53l3.818 3.82zm8.147 7.829h2.549c.254 0 .447.05.58.152a.49.49 0 0 1 .201.413.54.54 0 0 1-.159.393c-.105.108-.266.162-.48.162h-3.594c-.245 0-.435-.066-.572-.197a.621.621 0 0 1-.205-.463c0-.114.044-.265.132-.453a1.62 1.62 0 0 1 .288-.444c.433-.436.824-.81 1.172-1.122.348-.312.597-.517.747-.615.267-.183.49-.368.667-.553.177-.185.312-.375.405-.57.093-.194.139-.384.139-.57a1.008 1.008 0 0 0-.554-.917 1.197 1.197 0 0 0-.56-.133c-.426 0-.761.182-1.005.546a2.332 2.332 0 0 0-.164.39 1.609 1.609 0 0 1-.258.488c-.096.114-.237.17-.423.17a.558.558 0 0 1-.405-.156.568.568 0 0 1-.161-.427c0-.218.05-.446.151-.683.101-.238.252-.453.452-.646s.454-.349.762-.467a2.998 2.998 0 0 1 1.081-.178c.498 0 .923.076 1.274.228a1.916 1.916 0 0 1 1.004 1.032 1.984 1.984 0 0 1-.156 1.794c-.2.32-.405.572-.613.754-.208.182-.558.468-1.048.857-.49.39-.826.691-1.008.906a2.703 2.703 0 0 0-.24.309z\"/></svg>";
 
 const SUBSCRIPT = 'subscript';
-class SubscriptUI extends Plugin {
+/**
+ * The subscript UI feature. It introduces the Subscript button.
+ */ class SubscriptUI extends Plugin {
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'SubscriptUI';
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         const t = editor.locale.t;
         const createButton = getButtonCreator({
@@ -622,32 +704,42 @@ class SubscriptUI extends Plugin {
     }
 }
 
-class Subscript extends Plugin {
-    /**
-     * @inheritDoc
-     */ static get requires() {
+/**
+ * The subscript feature.
+ *
+ * It loads the {@link module:basic-styles/subscript/subscriptediting~SubscriptEditing} and
+ * {@link module:basic-styles/subscript/subscriptui~SubscriptUI} plugins.
+ */ class Subscript extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get requires() {
         return [
             SubscriptEditing,
             SubscriptUI
         ];
     }
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'Subscript';
     }
 }
 
 const SUPERSCRIPT$1 = 'superscript';
-class SuperscriptEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */ static get pluginName() {
+/**
+ * The superscript editing feature.
+ *
+ * It registers the `super` command and introduces the `super` attribute in the model which renders to the view
+ * as a `<super>` element.
+ */ class SuperscriptEditing extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'SuperscriptEditing';
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         // Allow super attribute on text nodes.
         editor.model.schema.extend('$text', {
@@ -677,15 +769,17 @@ class SuperscriptEditing extends Plugin {
 var superscriptIcon = "<svg viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M15.677 8.678h2.549c.254 0 .447.05.58.152a.49.49 0 0 1 .201.413.54.54 0 0 1-.159.393c-.105.108-.266.162-.48.162h-3.594c-.245 0-.435-.066-.572-.197a.621.621 0 0 1-.205-.463c0-.114.044-.265.132-.453a1.62 1.62 0 0 1 .288-.444c.433-.436.824-.81 1.172-1.122.348-.312.597-.517.747-.615.267-.183.49-.368.667-.553.177-.185.312-.375.405-.57.093-.194.139-.384.139-.57a1.008 1.008 0 0 0-.554-.917 1.197 1.197 0 0 0-.56-.133c-.426 0-.761.182-1.005.546a2.332 2.332 0 0 0-.164.39 1.609 1.609 0 0 1-.258.488c-.096.114-.237.17-.423.17a.558.558 0 0 1-.405-.156.568.568 0 0 1-.161-.427c0-.218.05-.446.151-.683.101-.238.252-.453.452-.646s.454-.349.762-.467a2.998 2.998 0 0 1 1.081-.178c.498 0 .923.076 1.274.228a1.916 1.916 0 0 1 1.004 1.032 1.984 1.984 0 0 1-.156 1.794c-.2.32-.405.572-.613.754-.208.182-.558.468-1.048.857-.49.39-.826.691-1.008.906a2.703 2.703 0 0 0-.24.309zM7.03 10.349l3.818-3.819a.8.8 0 1 1 1.132 1.132L8.16 11.48l3.819 3.818a.8.8 0 1 1-1.132 1.132L7.03 12.61l-3.818 3.82a.8.8 0 1 1-1.132-1.132L5.9 11.48 2.08 7.662A.8.8 0 1 1 3.212 6.53l3.818 3.82z\"/></svg>";
 
 const SUPERSCRIPT = 'superscript';
-class SuperscriptUI extends Plugin {
+/**
+ * The superscript UI feature. It introduces the Superscript button.
+ */ class SuperscriptUI extends Plugin {
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'SuperscriptUI';
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         const t = editor.locale.t;
         const createButton = getButtonCreator({
@@ -712,32 +806,42 @@ class SuperscriptUI extends Plugin {
     }
 }
 
-class Superscript extends Plugin {
-    /**
-     * @inheritDoc
-     */ static get requires() {
+/**
+ * The superscript feature.
+ *
+ * It loads the {@link module:basic-styles/superscript/superscriptediting~SuperscriptEditing} and
+ * {@link module:basic-styles/superscript/superscriptui~SuperscriptUI} plugins.
+ */ class Superscript extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get requires() {
         return [
             SuperscriptEditing,
             SuperscriptUI
         ];
     }
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'Superscript';
     }
 }
 
 const UNDERLINE$1 = 'underline';
-class UnderlineEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */ static get pluginName() {
+/**
+ * The underline editing feature.
+ *
+ * It registers the `'underline'` command, the <kbd>Ctrl+U</kbd> keystroke
+ * and introduces the `underline` attribute in the model which renders to the view as an `<u>` element.
+ */ class UnderlineEditing extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'UnderlineEditing';
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         const t = this.editor.t;
         // Allow strikethrough attribute on text nodes.
@@ -776,15 +880,17 @@ class UnderlineEditing extends Plugin {
 var underlineIcon = "<svg viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M3 18v-1.5h14V18zm2.2-8V3.6c0-.4.4-.6.8-.6.3 0 .7.2.7.6v6.2c0 2 1.3 2.8 3.2 2.8 1.9 0 3.4-.9 3.4-2.9V3.6c0-.3.4-.5.8-.5.3 0 .7.2.7.5V10c0 2.7-2.2 4-4.9 4-2.6 0-4.7-1.2-4.7-4z\"/></svg>";
 
 const UNDERLINE = 'underline';
-class UnderlineUI extends Plugin {
+/**
+ * The underline UI feature. It introduces the Underline button.
+ */ class UnderlineUI extends Plugin {
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'UnderlineUI';
     }
     /**
-     * @inheritDoc
-     */ init() {
+	 * @inheritDoc
+	 */ init() {
         const editor = this.editor;
         const command = editor.commands.get(UNDERLINE);
         const t = editor.locale.t;
@@ -811,18 +917,26 @@ class UnderlineUI extends Plugin {
     }
 }
 
-class Underline extends Plugin {
-    /**
-     * @inheritDoc
-     */ static get requires() {
+/**
+ * The underline feature.
+ *
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
+ * and the {@glink api/basic-styles package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:basic-styles/underline/underlineediting~UnderlineEditing} and
+ * {@link module:basic-styles/underline/underlineui~UnderlineUI} plugins.
+ */ class Underline extends Plugin {
+    /**
+	 * @inheritDoc
+	 */ static get requires() {
         return [
             UnderlineEditing,
             UnderlineUI
         ];
     }
     /**
-     * @inheritDoc
-     */ static get pluginName() {
+	 * @inheritDoc
+	 */ static get pluginName() {
         return 'Underline';
     }
 }