now using EsDoc, closes #2
This commit is contained in:
		
							
								
								
									
										30
									
								
								dist/npmts.jsdoc.js
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										30
									
								
								dist/npmts.jsdoc.js
									
									
									
									
										vendored
									
									
								
							@@ -3,26 +3,24 @@ require("typings-global");
 | 
			
		||||
var plugins = require("./npmts.plugins");
 | 
			
		||||
var paths = require("./npmts.paths");
 | 
			
		||||
var npmts_promisechain_1 = require("./npmts.promisechain");
 | 
			
		||||
var genJsdoc = function (configArg) {
 | 
			
		||||
var genEsDoc = function (configArg) {
 | 
			
		||||
    var done = plugins.Q.defer();
 | 
			
		||||
    npmts_promisechain_1.npmtsOra.text("now generating " + "JsDoc documentation".yellow);
 | 
			
		||||
    plugins.gulp.src([
 | 
			
		||||
        plugins.path.join(paths.cwd, "README.md"),
 | 
			
		||||
        plugins.path.join(paths.distDir, "**/*.js")
 | 
			
		||||
    ])
 | 
			
		||||
        .pipe(plugins.g.jsdoc3({
 | 
			
		||||
        opts: {
 | 
			
		||||
            destination: paths.docsDir
 | 
			
		||||
        }
 | 
			
		||||
    }, function () {
 | 
			
		||||
        plugins.beautylog.ok("JsDoc documentation has been generated!");
 | 
			
		||||
        done.resolve(configArg);
 | 
			
		||||
    }));
 | 
			
		||||
    npmts_promisechain_1.npmtsOra.text("now generating " + "EsDoc documentation".yellow);
 | 
			
		||||
    plugins.beautylog.log("ESDoc Output:");
 | 
			
		||||
    var esdocConfig = {
 | 
			
		||||
        source: paths.distDir,
 | 
			
		||||
        destination: paths.docsDir
 | 
			
		||||
    };
 | 
			
		||||
    plugins.esdoc.generate(esdocConfig, plugins.esdocPublisher);
 | 
			
		||||
    plugins.beautylog.ok("Docs by EsDoc have been created!");
 | 
			
		||||
    done.resolve(configArg);
 | 
			
		||||
    return done.promise;
 | 
			
		||||
};
 | 
			
		||||
exports.run = function (configArg) {
 | 
			
		||||
    var done = plugins.Q.defer();
 | 
			
		||||
    genJsdoc(configArg)
 | 
			
		||||
        .then(done.resolve);
 | 
			
		||||
    genEsDoc(configArg)
 | 
			
		||||
        .then(function () {
 | 
			
		||||
        done.resolve(configArg);
 | 
			
		||||
    });
 | 
			
		||||
    return done.promise;
 | 
			
		||||
};
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										3
									
								
								dist/npmts.plugins.d.ts
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								dist/npmts.plugins.d.ts
									
									
									
									
										vendored
									
									
								
							@@ -1,10 +1,11 @@
 | 
			
		||||
import "typings-global";
 | 
			
		||||
export import beautylog = require("beautylog");
 | 
			
		||||
export declare let esdoc: any;
 | 
			
		||||
export declare let esdocPublisher: any;
 | 
			
		||||
export declare let gulp: any;
 | 
			
		||||
export declare let g: {
 | 
			
		||||
    gFunction: any;
 | 
			
		||||
    istanbul: any;
 | 
			
		||||
    jsdoc3: any;
 | 
			
		||||
    mocha: any;
 | 
			
		||||
    replace: any;
 | 
			
		||||
    sourcemaps: any;
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										3
									
								
								dist/npmts.plugins.js
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								dist/npmts.plugins.js
									
									
									
									
										vendored
									
									
								
							@@ -1,11 +1,12 @@
 | 
			
		||||
"use strict";
 | 
			
		||||
require("typings-global");
 | 
			
		||||
exports.beautylog = require("beautylog");
 | 
			
		||||
exports.esdoc = require("esdoc");
 | 
			
		||||
exports.esdocPublisher = require("esdoc/out/src/Publisher/publish");
 | 
			
		||||
exports.gulp = require("gulp");
 | 
			
		||||
exports.g = {
 | 
			
		||||
    gFunction: require("gulp-function"),
 | 
			
		||||
    istanbul: require("gulp-istanbul"),
 | 
			
		||||
    jsdoc3: require("gulp-jsdoc3"),
 | 
			
		||||
    mocha: require("gulp-mocha"),
 | 
			
		||||
    replace: require("gulp-replace"),
 | 
			
		||||
    sourcemaps: require("gulp-sourcemaps")
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user