8
0
Maciej Gołaszewski 7 лет назад
Родитель
Сommit
1890123f10

+ 3 - 2
packages/ckeditor5-ckfinder/src/ckfinder.js

@@ -15,10 +15,8 @@ import CKFinderEditing from './ckfinderediting';
 /**
  * The CKFinder feature.
  *
- *
  * This is a "glue" plugin which enables:
  *
- * * {@link module:ckfinder/ckfinder~CKFinder},
  * * {@link module:ckfinder/ckfinderediting~CKFinderEditing},
  * * {@link module:ckfinder/ckfinderui~CKFinderUI}.
  *
@@ -32,6 +30,9 @@ export default class CKFinder extends Plugin {
 		return 'CKFinder';
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	static get requires() {
 		return [ CKFinderEditing, CKFinderUI ];
 	}

+ 11 - 2
packages/ckeditor5-ckfinder/src/ckfindercommand.js

@@ -6,7 +6,7 @@
 /* global window */
 
 /**
- * @module ckfinder/ckfinder
+ * @module ckfinder/ckfindercommand
  */
 
 import Command from '@ckeditor/ckeditor5-core/src/command';
@@ -14,15 +14,24 @@ import Command from '@ckeditor/ckeditor5-core/src/command';
 import { findOptimalInsertionPosition } from '@ckeditor/ckeditor5-widget/src/utils';
 
 /**
- * The CKFinder command.
+ * The CKFinder command. It is used by the {@link module:ckfinder/ckfinderediting~CKFinderEditing ckfinder editng feature}
+ * to open a CKFinder file browser to insert an image or a link to a file into content.
+ *
+ *		editor.execute( 'ckfinder' );
  *
  * @extends module:core/command~Command
  */
 export default class CKFinderCommand extends Command {
+	/**
+	 * @inheritDoc
+	 */
 	refresh() {
 		this.isEnabled = true;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	execute() {
 		const editor = this.editor;
 		// Execute command.

+ 12 - 1
packages/ckeditor5-ckfinder/src/ckfinderediting.js

@@ -10,14 +10,25 @@
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import CKFinderCommand from './ckfindercommand';
 
+/**
+ * The CKFinder editing feature. It introduces the {@link module:ckfinder/ckfindercommand~CKFinderCommand ckfinder command}.
+ *
+ * @extends module:core/plugin~Plugin
+ */
 export default class CKFinderEditing extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	static get pluginName() {
+		return 'CKFinderEditing';
+	}
+
 	/**
 	 * @inheritDoc
 	 */
 	init() {
 		const editor = this.editor;
 
-		// Register CKFinder command.
 		editor.commands.add( 'ckfinder', new CKFinderCommand( editor ) );
 	}
 }

+ 12 - 0
packages/ckeditor5-ckfinder/src/ckfinderui.js

@@ -12,7 +12,19 @@ import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
 
 import ckfinderIcon from '@ckeditor/ckeditor5-ui/theme/icons/dropdown-arrow.svg';
 
+/**
+ * The CKFinder UI plugin. It introduces he `'ckfinder'` toolbar button.
+ *
+ * @extends module:core/plugin~Plugin
+ */
 export default class CKFinderUI extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	static get pluginName() {
+		return 'CKFinderUI';
+	}
+
 	/**
 	 * @inheritDoc
 	 */