8
0
Pārlūkot izejas kodu

Fixed module name.

Piotrek Koszuliński 6 gadi atpakaļ
vecāks
revīzija
26fa1f09c3

+ 1 - 1
packages/ckeditor-cloud-services-core/docs/cloud-services-core.md

@@ -8,7 +8,7 @@ category: api-reference
 
 CKEditor Cloud Services Core API:
 
-* {@link module:ckeditor-cloud-services-core/uploadgateway~UploadGateway Upload Gateway} — API for file uploads to CKEditor Cloud Services.
+* {@link module:cloud-services-core/uploadgateway~UploadGateway Upload Gateway} — API for file uploads to CKEditor Cloud Services.
 
 ## Installation
 

+ 6 - 6
packages/ckeditor-cloud-services-core/src/token/token.js

@@ -4,7 +4,7 @@
  */
 
 /**
- * @module ckeditor-cloud-services-core/token
+ * @module cloud-services-core/token
  */
 
 /* globals XMLHttpRequest, setInterval, clearInterval */
@@ -27,7 +27,7 @@ class Token {
 	 * Method `init` should be called after using the constructor or use `create` method instead.
 	 *
 	 * @param {String|Function} tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
-	 * value is a function it has to match the {@link module:ckeditor-cloud-services-core/token~refreshToken} interface.
+	 * value is a function it has to match the {@link module:cloud-services-core/token~refreshToken} interface.
 	 * @param {Object} options
 	 * @param {String} [options.initValue] Initial value of the token.
 	 * @param {Number} [options.refreshInterval=3600000] Delay between refreshes. Default 1 hour.
@@ -80,7 +80,7 @@ class Token {
 	/**
 	 * Initializes the token.
 	 *
-	 * @returns {Promise.<module:ckeditor-cloud-services-core/token~Token>}
+	 * @returns {Promise.<module:cloud-services-core/token~Token>}
 	 */
 	init() {
 		return new Promise( ( resolve, reject ) => {
@@ -137,15 +137,15 @@ class Token {
 	}
 
 	/**
-	 * Creates a initialized {@link module:ckeditor-cloud-services-core/token~Token} instance.
+	 * Creates a initialized {@link module:cloud-services-core/token~Token} instance.
 	 *
 	 * @param {String|Function} tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
-	 * value is a function it has to match the {@link module:ckeditor-cloud-services-core/token~refreshToken} interface.
+	 * value is a function it has to match the {@link module:cloud-services-core/token~refreshToken} interface.
 	 * @param {Object} options
 	 * @param {String} [options.initValue] Initial value of the token.
 	 * @param {Number} [options.refreshInterval=3600000] Delay between refreshes. Default 1 hour.
 	 * @param {Boolean} [options.autoRefresh=true] Specifies whether to start the refresh automatically.
-	 * @returns {Promise.<module:ckeditor-cloud-services-core/token~Token>}
+	 * @returns {Promise.<module:cloud-services-core/token~Token>}
 	 */
 	static create( tokenUrlOrRefreshToken, options = DEFAULT_OPTIONS ) {
 		const token = new Token( tokenUrlOrRefreshToken, options );

+ 5 - 5
packages/ckeditor-cloud-services-core/src/uploadgateway/fileuploader.js

@@ -4,7 +4,7 @@
  */
 
 /**
- * @module ckeditor-cloud-services-core/uploadgateway
+ * @module cloud-services-core/uploadgateway
  */
 
 /* globals XMLHttpRequest, FormData, Blob, atob */
@@ -23,7 +23,7 @@ export default class FileUploader {
 	 * Creates `FileUploader` instance.
 	 *
 	 * @param {Blob|String} fileOrData A blob object or a data string encoded with Base64.
-	 * @param {module:ckeditor-cloud-services-core/token~Token} token Token used for authentication.
+	 * @param {module:cloud-services-core/token~Token} token Token used for authentication.
 	 * @param {String} apiAddress API address.
 	 */
 	constructor( fileOrData, token, apiAddress ) {
@@ -64,7 +64,7 @@ export default class FileUploader {
 		/**
 		 * CKEditor Cloud Services access token.
 		 *
-		 * @type {module:ckeditor-cloud-services-core/token~Token}
+		 * @type {module:cloud-services-core/token~Token}
 		 * @private
 		 */
 		this._token = token;
@@ -83,7 +83,7 @@ export default class FileUploader {
 	 *
 	 * @chainable
 	 * @param {Function} callback
-	 * @returns {module:ckeditor-cloud-services-core/uploadgateway~FileUploader}
+	 * @returns {module:cloud-services-core/uploadgateway~FileUploader}
 	 */
 	onProgress( callback ) {
 		this.on( 'progress', ( event, data ) => callback( data ) );
@@ -96,7 +96,7 @@ export default class FileUploader {
 	 *
 	 * @chainable
 	 * @param {Function} callback
-	 * @returns {module:ckeditor-cloud-services-core/uploadgateway~FileUploader}
+	 * @returns {module:cloud-services-core/uploadgateway~FileUploader}
 	 */
 	onError( callback ) {
 		this.once( 'error', ( event, data ) => callback( data ) );

+ 6 - 6
packages/ckeditor-cloud-services-core/src/uploadgateway/uploadgateway.js

@@ -4,7 +4,7 @@
  */
 
 /**
- * @module ckeditor-cloud-services-core/uploadgateway
+ * @module cloud-services-core/uploadgateway
  */
 
 import FileUploader from './fileuploader';
@@ -17,7 +17,7 @@ export default class UploadGateway {
 	/**
 	 * Creates `UploadGateway` instance.
 	 *
-	 * @param {module:ckeditor-cloud-services-core/token~Token} token Token used for authentication.
+	 * @param {module:cloud-services-core/token~Token} token Token used for authentication.
 	 * @param {String} apiAddress API address.
 	 */
 	constructor( token, apiAddress ) {
@@ -42,7 +42,7 @@ export default class UploadGateway {
 		/**
 		 * CKEditor Cloud Services access token.
 		 *
-		 * @type {module:ckeditor-cloud-services-core/token~Token}
+		 * @type {module:cloud-services-core/token~Token}
 		 * @private
 		 */
 		this._token = token;
@@ -57,9 +57,9 @@ export default class UploadGateway {
 	}
 
 	/**
-	 * Creates a {@link module:ckeditor-cloud-services-core/uploadgateway~FileUploader} instance that wraps
+	 * Creates a {@link module:cloud-services-core/uploadgateway~FileUploader} instance that wraps
 	 * file upload process. The file is being sent at a time when the
-	 * {@link module:ckeditor-cloud-services-core/uploadgateway~FileUploader#send} method is called.
+	 * {@link module:cloud-services-core/uploadgateway~FileUploader#send} method is called.
 	 *
 	 *     const token = await Token.create( 'https://token-endpoint' );
 	 *     new UploadGateway( token, 'https://example.org' )
@@ -69,7 +69,7 @@ export default class UploadGateway {
 	 *        .then( ( response ) => console.log( response ) );
 	 *
 	 * @param {Blob|String} fileOrData A blob object or a data string encoded with Base64.
-	 * @returns {module:ckeditor-cloud-services-core/uploadgateway~FileUploader} Returns `FileUploader` instance.
+	 * @returns {module:cloud-services-core/uploadgateway~FileUploader} Returns `FileUploader` instance.
 	 */
 	upload( fileOrData ) {
 		return new FileUploader( fileOrData, this._token, this._apiAddress );