javascript - TypeDoc creating empty documentation -


i have gulp task supposed take files , create documentation them. task looks this:

var gulp = require('gulp'); var gulptypedoc = require('gulp-typedoc');  gulp.task('typedoc-gamesmart', function () {     return gulp.src([         './src/util/config.ts',         './src/util/http.ts',         './typings/crypto-js/crypto-js.d.ts',         './src/gamesmart/gamesmart.ts',         './src/gamesmart/apis/client.ts',         './src/gamesmart/apis/data.ts',         './src/gamesmart/apis/game.ts',         './src/gamesmart/apis/score.ts',         './src/gamesmart/apis/store.ts',         './src/gamesmart/apis/user.ts',         './src/gamesmart/main.ts',     ]).pipe(gulptypedoc({         // module: 'system',         target: 'es5',         out: 'docs/gamesmart/',         name: 'gamesmart sdk',         excludenotexported: true,         mode: 'file',         version: true     })); }); 

when completes, empty docs.

empty docs

here example of class structure:

class score extends gamesmart {      /**      * saves score game      *      * @param {number} score        score saved.      * @param {function} callback   callback run once complete.      * @returns      */     public save(options: { score?: number } = {}, callback: function = null, obj: object = null): void {         if ((options.score || 0) <= 0) { return; }         this.makerequest('/save', httpmethod.post, options, callback, obj);     }  } 

as can see, not using modules, documentation says use mode: 'file' did, , not getting anything.

if use mode: 'modules', list of classes, no documentation:

empty doc modules

is there doing wrong?

to reiterate @sven said, no documentation generated if use excludednotexported feature while not exporting symbols. change flag document whole project.

{ // typedoc config     target: 'es5',     out: 'docs/gamesmart/',     name: 'gamesmart sdk',     excludenotexported: false,     mode: 'file',     version: true } 

Comments

Popular posts from this blog

serialization - Convert Any type in scala to Array[Byte] and back -

matplotlib support failed in PyCharm on OSX -

python - Matplotlib: TypeError: 'AxesSubplot' object is not callable -