Szymon Kupś 8 lat temu
rodzic
commit
1c7075806e

+ 5 - 2
packages/ckeditor5-upload/src/filerepository.js

@@ -65,7 +65,10 @@ export default class FileRepository extends Plugin {
 		this.set( 'uploaded', 0 );
 
 		/**
-		 * Number of total bytes to upload. It contains `null` if value is not available yet.
+		 * Number of total bytes to upload.
+		 * It might be different than the file size because of headers and additional data.
+		 * It contains `null` if value is not available yet, so it's better to use {@link #uploadPercent} to monitor
+		 * the progress.
 		 *
 		 * @readonly
 		 * @observable
@@ -104,7 +107,7 @@ export default class FileRepository extends Plugin {
 
 	/**
 	 * Creates loader for specified file.
-	 * Shows console warning and returns `null` if {@link #createAdapter} method is not defined..
+	 * Shows console warning and returns `null` if {@link #createAdapter} method is not defined.
 	 *
 	 * @param {File} file Native File object.
 	 * @returns {module:upload/filerepository~FileLoader|null}

+ 2 - 0
packages/ckeditor5-upload/src/imageuploadengine.js

@@ -23,6 +23,7 @@ export default class ImageUploadEngine extends Plugin {
 		/**
 		 * Image's placeholder that is displayed before real image data can be accessed.
 		 *
+		 * @protected
 		 * @member {String} #placeholder
 		 */
 		this.placeholder = 'data:image/svg+xml;utf8,' + uploadingPlaceholder;
@@ -99,6 +100,7 @@ export default class ImageUploadEngine extends Plugin {
 	 * Performs image loading. Image is read from the disk and temporary data is displayed, after uploading process
 	 * is complete we replace temporary data with target image from the server.
 	 *
+	 * @protected
 	 * @param {module:upload/filerepository~FileLoader} loader
 	 * @param {module:engine/model/batch~Batch} batch
 	 * @param {module:engine/model/element~Element} imageElement