8
0
Oskar Wrobel 9 gadi atpakaļ
vecāks
revīzija
f9c69ef8f2
2 mainītis faili ar 13 papildinājumiem un 13 dzēšanām
  1. 3 3
      dev/tasks/bundle/tasks.js
  2. 10 10
      dev/tasks/bundle/utils.js

+ 3 - 3
dev/tasks/bundle/tasks.js

@@ -46,7 +46,7 @@ module.exports = ( config ) => {
 		 * 			// Path to specified editor.
 		 * 			// It could be a path relative to `build/esnext/ckeditor5` directory e.g. `classic-editor/classic.js`
 		 * 			// or path relative to directory where build task will be executed `./full/path/to/custom/editor.js`.
-		 * 			editor: 'classic-editor/classic.js'
+		 * 			editor: 'classic-editor/classic.js',
 		 *
 		 * 			// List of features.
 		 * 			features: [
@@ -61,8 +61,8 @@ module.exports = ( config ) => {
 		 * 			]
 		 * 		}
 		 *
-		 * @params {String} configFilePath Path to the bundle configuration file.
-		 * @return {Promise} Promise that resolve bundling for CSS anf JS.
+		 * @param {String} configFilePath Path to the bundle configuration file.
+		 * @returns {Promise} Promise that resolve bundling for CSS and JS.
 		 */
 		generate( configFilePath ) {
 			// When config file is not specified.

+ 10 - 10
dev/tasks/bundle/utils.js

@@ -34,7 +34,7 @@ const utils = {
 
 	/**
 	 * When module path is not relative then treat this path as a path to the one of the ckeditor5 default module
-	 * (relative to ./bundle/exnext/ckedotir5) and add prefix `./build/esnext/ckeditor5/` to this path.
+	 * (relative to ./bundle/exnext/ckeditor5) and add prefix `./build/esnext/ckeditor5/` to this path.
 	 *
 	 * @param {String} modulePath Path the ckeditor5 module.
 	 */
@@ -65,7 +65,7 @@ const utils = {
 	/**
 	 * Transform first letter of passed string to the uppercase.
 	 *
-	 * @params {String} string String that will be transformed.
+	 * @param {String} string String that will be transformed.
 	 * @returns {String} Transformed string.
 	 */
 	capitalize( string ) {
@@ -142,8 +142,8 @@ export default class ${ data.moduleName } extends ${ creatorName } {
 	/**
 	 * Save files from stream in specific destination and add `.min` suffix to the name.
 	 *
-	 * @params {Stream} stream Source stream.
-	 * @params {String} destination Path to the destination directory.
+	 * @param {Stream} stream Source stream.
+	 * @param {String} destination Path to the destination directory.
 	 * @returns {Stream}
 	 */
 	saveFileFromStreamAsMinified( stream, destination ) {
@@ -157,8 +157,8 @@ export default class ${ data.moduleName } extends ${ creatorName } {
 	/**
 	 * Copy specified file to specified destination.
 	 *
-	 * @params {String} from Source path.
-	 * @params {String} to Destination directory.
+	 * @param {String} from Source path.
+	 * @param {String} to Destination directory.
 	 * @returns {Promise}
 	 */
 	copyFile( from, to ) {
@@ -172,7 +172,7 @@ export default class ${ data.moduleName } extends ${ creatorName } {
 	/**
 	 * Get size of the file.
 	 *
-	 * @params {String} path Path to the file.
+	 * @param {String} path Path to the file.
 	 * @returns {Number} Size in bytes.
 	 */
 	getFileSize( path ) {
@@ -182,7 +182,7 @@ export default class ${ data.moduleName } extends ${ creatorName } {
 	/**
 	 * Get human readable gzipped size of the file.
 	 *
-	 * @params {String} path Path to the file.
+	 * @param {String} path Path to the file.
 	 * @returns {Number} Size in bytes.
 	 */
 	getGzippedFileSize( path ) {
@@ -192,8 +192,8 @@ export default class ${ data.moduleName } extends ${ creatorName } {
 	/**
 	 * Get normal and gzipped size of every passed file in specified directory.
 	 *
-	 * @params {Array.<String>} files List of file paths.
-	 * @params {String} [rootDir=''] When each file is in the same directory.
+	 * @param {Array.<String>} files List of file paths.
+	 * @param {String} [rootDir=''] When each file is in the same directory.
 	 * @returns {Array.<Object>} List with file size data.
 	 * @returns {Array.<Object.name>} File name.
 	 * @returns {Array.<Object.size>} File size in human readable format.