Kaynağa Gözat

Docs: Added explicit inheriting docs for init / constructor methods.

Also added short foreword to the SpecialCharactersEssentials plugin.
Marek Lewandowski 6 yıl önce
ebeveyn
işleme
ed65a8b0b2

+ 3 - 0
packages/ckeditor5-special-characters/src/specialcharacters.js

@@ -19,6 +19,9 @@ import '../theme/specialcharacters.css';
  * @extends module:core/plugin~Plugin
  */
 export default class SpecialCharacters extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
 	constructor( editor ) {
 		super( editor );
 

+ 3 - 0
packages/ckeditor5-special-characters/src/specialcharactersarrows.js

@@ -10,6 +10,9 @@
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 
 export default class SpecialCharactersArrows extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
 	init() {
 		this.editor.plugins.get( 'SpecialCharacters' ).addItems( 'Arrows', [
 			{ title: 'leftwards double arrow', character: '⇐' },

+ 3 - 0
packages/ckeditor5-special-characters/src/specialcharacterscurrency.js

@@ -10,6 +10,9 @@
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 
 export default class SpecialCharactersCurrency extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
 	init() {
 		this.editor.plugins.get( 'SpecialCharacters' ).addItems( 'Currency', [
 			{

+ 3 - 0
packages/ckeditor5-special-characters/src/specialcharactersessentials.js

@@ -15,6 +15,9 @@ import SpecialCharactersArrows from './specialcharactersarrows';
 import SpecialCharactersLatin from './specialcharacterslatin';
 import SpecialCharactersText from './specialcharacterstext';
 
+/**
+ * A plugin combining basic set of characters for the special characters plugin.
+ */
 export default class SpecialCharactersEssentials extends Plugin {
 	/**
 	 * @inheritDoc

+ 3 - 0
packages/ckeditor5-special-characters/src/specialcharacterslatin.js

@@ -10,6 +10,9 @@
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 
 export default class SpecialCharactersLatin extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
 	init() {
 		this.editor.plugins.get( 'SpecialCharacters' ).addItems( 'Latin', [
 			{

+ 3 - 0
packages/ckeditor5-special-characters/src/specialcharactersmathematical.js

@@ -10,6 +10,9 @@
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 
 export default class SpecialCharactersMathematical extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
 	init() {
 		this.editor.plugins.get( 'SpecialCharacters' ).addItems( 'Mathematical', [
 			{

+ 3 - 0
packages/ckeditor5-special-characters/src/specialcharacterstext.js

@@ -10,6 +10,9 @@
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 
 export default class SpecialCharactersText extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
 	init() {
 		this.editor.plugins.get( 'SpecialCharacters' ).addItems( 'Text', [
 			{

+ 3 - 0
packages/ckeditor5-special-characters/src/specialcharactersui.js

@@ -28,6 +28,9 @@ export default class SpecialCharactersUI extends Plugin {
 		return 'SpecialCharactersUI';
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	init() {
 		const editor = this.editor;
 		const t = editor.t;