node package manager
Painless code sharing. npm Orgs help your team discover, share, and reuse code. Create a free org »

uotes-doc-generator

uoTES.js - ドキュメントジェネレータ

uoTES.jsのドキュメントジェネレータです。
モジュール定義とドキュメント定義から、uoTESモジュールのドキュメントファイルを生成します。

uoTES.jsについて

下記リンクを参照してください。
https://github.com/RaTTiE/uotes-core

使い方

npm経由でグローバルインストールすることで、tesdocコマンドが利用可能になります。

tesdoc [options]

オプション

  • -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>:出力対象の言語を指定します。省略時は定義されているすべての言語のドキュメントを出力します。

使用ライブラリ

このプログラムには以下のライブラリが使用されています。

ライセンス

The MIT License (MIT)

NPM