2016-09-07 14 views
1

私はgulpタスクを持っています。このタスクは自分のファイルを受け取り、そのドキュメントを作成することになっています。タスクは次のようになります。TypeDoc空のドキュメントを作成する

完了すると、私は空のドキュメントを取得します。ドキュメントは私がやったmode: 'file'を使用するように言うように、あなたが見ることができるように、私はモジュールを使用していない

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); 
    } 

} 

、およびI:ここで

Empty Docs

は、クラス構造の一例です何も得られていない。

私はmode: 'modules'を使用している場合は、私はクラスのリストを取得しますが、ないドキュメント:

Empty Doc Modules

は私が間違っているのものはありませんか?

+3

あなたは 'Score'クラスをエクスポートしていないので、' excludeNotExported'は 'true'ではなく' false'でなければならないかもしれませんか? –

+0

問題を修正したようです。ありがとう! –

答えて

0

記号をエクスポートしないでexcludedNotExported機能を使用すると、@ Svenが何を述べたかを繰り返し述べると、ドキュメントは生成されません。このフラグを変更して、プロジェクト全体を文書化します。

{ // TypeDoc config 
    target: 'es5', 
    out: 'docs/gamesmart/', 
    name: 'GameSmart SDK', 
    excludeNotExported: false, 
    mode: 'file', 
    version: true 
} 
関連する問題