Преглед на файлове

Docs: Update documentation links and add missing docs.

Maciej Gołaszewski преди 7 години
родител
ревизия
bc5ea8ebff

+ 3 - 0
packages/ckeditor5-upload/src/filereader.js

@@ -16,6 +16,9 @@ import mix from '@ckeditor/ckeditor5-utils/src/mix';
  * FileReader class - wrapper over native FileReader.
  */
 export default class FileReader {
+	/**
+	 * Creates an instance of the FileReader.
+	 */
 	constructor() {
 		const reader = new window.FileReader();
 

+ 1 - 1
packages/ckeditor5-upload/src/filerepository.js

@@ -144,7 +144,7 @@ export default class FileRepository extends Plugin {
 			 *
 			 * **If you see this warning when using a custom build** there is a chance that you enabled
 			 * a feature like {@link module:upload/imageupload~ImageUpload},
-			 * or {@link module:upload/imageuploadbutton~ImageUploadUI} but you did not enable any upload adapter.
+			 * or {@link module:upload/imageuploadui~ImageUploadUI} but you did not enable any upload adapter.
 			 * You can choose one of the existing upload adapters:
 			 *
 			 * * {@link module:easy-image/cloudservicesuploadadapter~CloudServicesUploadAdapter}

+ 3 - 1
packages/ckeditor5-upload/src/imageupload.js

@@ -14,8 +14,10 @@ import ImageUploadEditing from './imageuploadediting';
 
 /**
  * Image upload plugin.
+ *
  * This plugin do not do anything directly, but loads set of specific plugins to enable image uploading:
- * * {@link module:upload/imageuploadbutton~ImageUploadUI},
+ * * {@link module:upload/imageuploadediting~ImageUploadEditing},
+ * * {@link module:upload/imageuploadui~ImageUploadUI},
  * * {@link module:upload/imageuploadprogress~ImageUploadProgress}.
  *
  * @extends module:core/plugin~Plugin

+ 2 - 2
packages/ckeditor5-upload/src/imageuploadediting.js

@@ -4,7 +4,7 @@
  */
 
 /**
- * @module upload/imageuploadengine
+ * @module upload/imageuploadediting
  */
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
@@ -15,7 +15,7 @@ import ModelSelection from '@ckeditor/ckeditor5-engine/src/model/selection';
 import { isImageType, findOptimalInsertionPosition } from './utils';
 
 /**
- * Image upload engine plugin.
+ * Image upload editing plugin.
  *
  * @extends module:core/plugin~Plugin
  */

+ 3 - 0
packages/ckeditor5-upload/src/imageuploadprogress.js

@@ -36,6 +36,9 @@ export default class ImageUploadProgress extends Plugin {
 		this.placeholder = 'data:image/svg+xml;utf8,' + encodeURIComponent( uploadingPlaceholder );
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	init() {
 		const editor = this.editor;
 

+ 1 - 1
packages/ckeditor5-upload/src/imageuploadui.js

@@ -4,7 +4,7 @@
  */
 
 /**
- * @module upload/imageuploadbutton
+ * @module upload/imageuploadui
  */
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';