8
0
Prechádzať zdrojové kódy

Minor improvements for the gulp docs task.

Piotrek Koszuliński 10 rokov pred
rodič
commit
b068697cfd

+ 0 - 1
.gitignore

@@ -11,4 +11,3 @@ node_modules/**
 build/**
 coverage/**
 dist/**
-out/jsdoc

+ 4 - 1
dev/tasks/build/tasks.js

@@ -1,4 +1,7 @@
-/* jshint node: true, esnext: true */
+/**
+ * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
 
 'use strict';
 

+ 4 - 1
dev/tasks/build/utils.js

@@ -1,4 +1,7 @@
-/* jshint node: true, esnext: true */
+/**
+ * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
 
 'use strict';
 

+ 4 - 1
dev/tasks/dev/tasks.js

@@ -1,4 +1,7 @@
-/* jshint node: true, esnext: true */
+/**
+ * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
 
 'use strict';
 

+ 5 - 0
dev/tasks/dev/utils/tools.js

@@ -1,3 +1,8 @@
+/**
+ * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
 'use strict';
 
 const dependencyRegExp = /^ckeditor5-/;

+ 0 - 0
dev/tasks/jsdoc/conf.json → dev/tasks/docs/conf.json


+ 2 - 2
dev/tasks/jsdoc/jsdoc.json → dev/tasks/docs/jsdoc.json

@@ -1,13 +1,13 @@
 {
 	"opts": {
 		"encoding": "utf8",
-		"destination": "out/jsdoc",
+		"destination": "dist/docs",
 		"recurse": true,
 		"access": "all"
 	},
 	"plugins": [
 		"node_modules/jsdoc/plugins/markdown",
-		"dev/tasks/jsdoc/plugins/comment-fixer"
+		"dev/tasks/docs/plugins/comment-fixer"
 	],
 	"source": {
 		"include": [

+ 4 - 1
dev/tasks/jsdoc/plugins/comment-fixer.js → dev/tasks/docs/plugins/comment-fixer.js

@@ -1,4 +1,7 @@
-/* jshint node: true, esnext: true */
+/**
+ * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
 
 module.exports = {
 	handlers: {

+ 6 - 3
dev/tasks/jsdoc/tasks.js → dev/tasks/docs/tasks.js

@@ -1,4 +1,7 @@
-/* jshint node: true, esnext: true */
+/**
+ * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
 
 'use strict';
 
@@ -7,9 +10,9 @@ const jsdoc = require( 'gulp-jsdoc3' );
 
 module.exports = () => {
 	gulp.task( 'docs', [ 'build-esnext' ], function( cb ) {
-		let config = require( './jsdoc.json' );
+		const config = require( './jsdoc.json' );
 
-		// Add readme to output
+		// Add the readme to the output.
 		gulp.src( [ 'README.md' ], { read: false } )
 			.pipe( jsdoc( config, cb ) );
 	} );

+ 1 - 1
gulpfile.js

@@ -18,7 +18,7 @@ const config = {
 require( './dev/tasks/build/tasks' )( config );
 require( './dev/tasks/dev/tasks' )( config );
 require( './dev/tasks/lint/tasks' )( config );
-require( './dev/tasks/jsdoc/tasks' )( config );
+require( './dev/tasks/docs/tasks' )( config );
 
 gulp.task( 'default', [ 'build' ] );
 gulp.task( 'pre-commit', [ 'lint-staged' ] );