Javascript TypeDoc创建空文档
我有一个Javascript TypeDoc创建空文档,javascript,typescript,gulp,typedoc,gulp-typedoc,Javascript,Typescript,Gulp,Typedoc,Gulp Typedoc,我有一个gulp任务,任务是获取我的文件并为它们创建文档。任务如下所示: 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', './t
gulp
任务,任务是获取我的文件并为它们创建文档。任务如下所示:
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
}));
});
当它完成时,我会得到空文档
下面是类结构的一个示例:
class Score extends GameSmart {
/**
* Saves a score for the game
*
* @param {number} score The score to be saved.
* @param {Function} callback The callback to 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);
}
}
类分数扩展GameSmart{
/**
*为比赛保存分数
*
*@param{number}为要保存的分数打分。
*@param{Function}回调完成后运行的回调。
*@返回
*/
公共保存(选项:{score?:number}={},回调:Function=null,obj:Object=null):void{
如果((options.score | | | 0)要重申@Sven所说的话,如果在不导出任何符号的情况下使用excludedNotExported
功能,则不会生成任何文档。请更改此标志以记录整个项目
{ // TypeDoc config
target: 'es5',
out: 'docs/gamesmart/',
name: 'GameSmart SDK',
excludeNotExported: false,
mode: 'file',
version: true
}
为了重申@Sven所说的,如果在不导出任何符号的情况下使用excludedNotExported
功能,则不会生成任何文档。请更改此标志以记录整个项目
{ // TypeDoc config
target: 'es5',
out: 'docs/gamesmart/',
name: 'GameSmart SDK',
excludeNotExported: false,
mode: 'file',
version: true
}
你没有导出你的分数
类,所以可能excludeNoteExported
应该是false
而不是true
?这看起来解决了问题!谢谢!你没有导出你的分数
类,所以excludeNoteExported
应该是false
而不是true
?那就是看来问题解决了!谢谢!