Kamil Piechaczek пре 6 година
родитељ
комит
9ae2ba9691

+ 14 - 2
packages/ckeditor5-special-characters/src/specialcharactersarrows.js

@@ -4,12 +4,24 @@
  */
 
 /**
- * @module special-characters/specialcharacters
+ * @module special-characters/specialcharactersarrows
  */
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import SpecialCharacters from './specialcharacters';
 
+/**
+ * A plugin provides special characters for the "Arrows" category.
+ *
+ *		ClassicEditor
+ *			.create( {
+ *				plugins: [ ..., SpecialCharacters, SpecialCharactersArrows ],
+ *			} )
+ *			.then( ... )
+ *			.catch( ... );
+ *
+ * @extends module:core/plugin~Plugin
+ */
 export default class SpecialCharactersArrows extends Plugin {
 	/**
 	 * @inheritDoc
@@ -27,7 +39,7 @@ export default class SpecialCharactersArrows extends Plugin {
 		const editor = this.editor;
 		const t = editor.t;
 
-		this.editor.plugins.get( 'SpecialCharacters' ).addItems( 'Arrows', [
+		editor.plugins.get( 'SpecialCharacters' ).addItems( 'Arrows', [
 			{ title: t( 'leftwards double arrow' ), character: '⇐' },
 			{ title: t( 'rightwards double arrow' ), character: '⇒' },
 			{ title: t( 'upwards double arrow' ), character: '⇑' },

+ 14 - 2
packages/ckeditor5-special-characters/src/specialcharacterscurrency.js

@@ -4,12 +4,24 @@
  */
 
 /**
- * @module special-characters/specialcharacters
+ * @module special-characters/specialcharacterscurrency
  */
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import SpecialCharacters from './specialcharacters';
 
+/**
+ * A plugin provides special characters for the "Currency" category.
+ *
+ *		ClassicEditor
+ *			.create( {
+ *				plugins: [ ..., SpecialCharacters, SpecialCharactersCurrency ],
+ *			} )
+ *			.then( ... )
+ *			.catch( ... );
+ *
+ * @extends module:core/plugin~Plugin
+ */
 export default class SpecialCharactersCurrency extends Plugin {
 	/**
 	 * @inheritDoc
@@ -27,7 +39,7 @@ export default class SpecialCharactersCurrency extends Plugin {
 		const editor = this.editor;
 		const t = editor.t;
 
-		this.editor.plugins.get( 'SpecialCharacters' ).addItems( 'Currency', [
+		editor.plugins.get( 'SpecialCharacters' ).addItems( 'Currency', [
 			{ character: '$', title: t( 'Dollar sign' ) },
 			{ character: '€', title: t( 'Euro sign' ) },
 			{ character: '¥', title: t( 'Yen sign' ) },

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

@@ -4,7 +4,7 @@
  */
 
 /**
- * @module special-characters/specialcharacters
+ * @module special-characters/specialcharactersessentials
  */
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
@@ -25,6 +25,8 @@ import SpecialCharactersText from './specialcharacterstext';
  *			} )
  *			.then( ... )
  *			.catch( ... );
+ *
+ * @extends module:core/plugin~Plugin
  */
 export default class SpecialCharactersEssentials extends Plugin {
 	/**

+ 14 - 2
packages/ckeditor5-special-characters/src/specialcharacterslatin.js

@@ -4,12 +4,24 @@
  */
 
 /**
- * @module special-characters/specialcharacters
+ * @module special-characters/specialcharacterslatin
  */
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import SpecialCharacters from './specialcharacters';
 
+/**
+ * A plugin provides special characters for the "Latin" category.
+ *
+ *		ClassicEditor
+ *			.create( {
+ *				plugins: [ ..., SpecialCharacters, SpecialCharactersLatin ],
+ *			} )
+ *			.then( ... )
+ *			.catch( ... );
+ *
+ * @extends module:core/plugin~Plugin
+ */
 export default class SpecialCharactersLatin extends Plugin {
 	/**
 	 * @inheritDoc
@@ -27,7 +39,7 @@ export default class SpecialCharactersLatin extends Plugin {
 		const editor = this.editor;
 		const t = editor.t;
 
-		this.editor.plugins.get( 'SpecialCharacters' ).addItems( 'Latin', [
+		editor.plugins.get( 'SpecialCharacters' ).addItems( 'Latin', [
 			{ character: 'Ā', title: t( 'Latin capital letter a with macron' ) },
 			{ character: 'ā', title: t( 'Latin small letter a with macron' ) },
 			{ character: 'Ă', title: t( 'Latin capital letter a with breve' ) },

+ 14 - 2
packages/ckeditor5-special-characters/src/specialcharactersmathematical.js

@@ -4,12 +4,24 @@
  */
 
 /**
- * @module special-characters/specialcharacters
+ * @module special-characters/specialcharactersmathematical
  */
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import SpecialCharacters from './specialcharacters';
 
+/**
+ * A plugin provides special characters for the "Mathematical" category.
+ *
+ *		ClassicEditor
+ *			.create( {
+ *				plugins: [ ..., SpecialCharacters, SpecialCharactersMathematical ],
+ *			} )
+ *			.then( ... )
+ *			.catch( ... );
+ *
+ * @extends module:core/plugin~Plugin
+ */
 export default class SpecialCharactersMathematical extends Plugin {
 	/**
 	 * @inheritDoc
@@ -27,7 +39,7 @@ export default class SpecialCharactersMathematical extends Plugin {
 		const editor = this.editor;
 		const t = editor.t;
 
-		this.editor.plugins.get( 'SpecialCharacters' ).addItems( 'Mathematical', [
+		editor.plugins.get( 'SpecialCharacters' ).addItems( 'Mathematical', [
 			{ character: '<', title: t( 'Less-than sign' ) },
 			{ character: '>', title: t( 'Greater-than sign' ) },
 			{ character: '≤', title: t( 'Less-than or equal to' ) },

+ 14 - 2
packages/ckeditor5-special-characters/src/specialcharacterstext.js

@@ -4,12 +4,24 @@
  */
 
 /**
- * @module special-characters/specialcharacters
+ * @module special-characters/specialcharacterstext
  */
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import SpecialCharacters from './specialcharacters';
 
+/**
+ * A plugin provides special characters for the "Text" category.
+ *
+ *		ClassicEditor
+ *			.create( {
+ *				plugins: [ ..., SpecialCharacters, SpecialCharactersText ],
+ *			} )
+ *			.then( ... )
+ *			.catch( ... );
+ *
+ * @extends module:core/plugin~Plugin
+ */
 export default class SpecialCharactersText extends Plugin {
 	/**
 	 * @inheritDoc
@@ -27,7 +39,7 @@ export default class SpecialCharactersText extends Plugin {
 		const editor = this.editor;
 		const t = editor.t;
 
-		this.editor.plugins.get( 'SpecialCharacters' ).addItems( 'Text', [
+		editor.plugins.get( 'SpecialCharacters' ).addItems( 'Text', [
 			{ character: '‹', title: t( 'Single left-pointing angle quotation mark' ) },
 			{ character: '›', title: t( 'Single right-pointing angle quotation mark' ) },
 			{ character: '«', title: t( 'Left-pointing double angle quotation mark' ) },