ジェネレータの起動

ドキュメントジェネレータのインストールが完了している場合、コマンドライン上からtesdocコマンドを使用することが可能です。 コマンドプロンプト上で以下のコマンドを入力します。

tesdoc -m <作成対象のモジュール名>

コマンドを実行すると、ドキュメント作成処理が実行され、コンソール画面に結果が表示されます。

作成処理が完了すると、作成を実行したフォルダに「doc-<モジュール名>>というフォルダが出力されます。

また、ドキュメントジェネレータには様々なオプションを指定することができます。
ドキュメントジェネレータに指定できるオプションは以下の通りです。

• -h, --help
  ヘルプを表示します。
• -V, --version
  バージョン情報を表示します。
• -m, --module <module>
  使用するモジュールを指定します。
  このオプションは必須です。
  モジュールは"uotes-module-xx"の形式で作成されたnodeモジュールで、あらかじめグローバルインストールされている必要があります。
  "uotes-module-"以降の名称を指定してください。
• -d, --document <document>
  使用するドキュメント定義を指定します。
  モジュールは"uotes-document-xx"の形式で作成されたnodeモジュールで、あらかじめグローバルインストールされている必要があります。
  "uotes-document-"以降の名称を指定してください。
  オプション省略時はモジュールと同名のドキュメント定義を読み込みます。
• -o, -out <outdir>
  ファイルを書き出すディレクトリを指定します。
  省略時はカレントディレクトリが使用されます。
• -l, -language <language>
  出力対象の言語を指定します。
  省略時は定義されているすべての言語のドキュメントを出力します。