これは、Ubuntu Online、Fedora Online、Windows オンライン エミュレーター、または MAC OS オンライン エミュレーターなどの複数の無料オンライン ワークステーションの XNUMX つを使用して、OnWorks 無料ホスティング プロバイダーで実行できるコマンド ldoc です。
プログラム:
NAME
ldoc - LuaDoc 互換のドキュメント生成システム
DESCRIPTION
LDoc、LuaDoc と互換性のある Lua 用のドキュメント ジェネレーター。
OPTIONS
-NS、 --ディレクトリ
(デフォルトのドキュメント) 出力ディレクトリ
-o、 - 出力
(デフォルトの「インデックス」) 出力名
-v、 -詳細
ドキュメントの生成中に冗長になる
-a、 - すべて
ローカル関数などをドキュメントに表示する
-NS、 - 静かな
出力を抑制する
-NS、 -モジュール
テキストとしてのモジュールドキュメント
-s、 - スタイル
(デフォルト!) スタイルシート (ldoc.css) のディレクトリ
-l、 - レンプレート
(デフォルト!) テンプレート (ldoc.ltp) のディレクトリ
-NS、 - 事業
(デフォルトの ldoc) プロジェクト名
-NS、 - 題名
(デフォルトの参照) ページタイトル
-NS、 - フォーマット
(デフォルトのプレーン) 書式設定、有効なオプションはマークダウン、割引、またはプレーンです。
-NS、 - パッケージ
(デフォルト。) 最上位パッケージのベース名 ( モジュール(...))
-NS、 --内線
(デフォルトの HTML) 出力ファイル拡張子
-NS、 --config
(デフォルトの config.ld) 構成名
-私、 - 無視
「ドキュメントコメントなしまたはモジュールなし」の警告は無視します
-NS、 --not_luadoc
LuaDoc の互換性を破壊します。 説明はタグの後に続く場合があります。
-NS、 - 定義
(デフォルトはなし) config.ld で使用されるフラグを設定します。
-C、 - 結腸
コロンスタイルを使用する
-NS、 --定型文
ソースファイルの最初のコメントを無視する
-NS、 - マージ
モジュールのマージを許可する
-NS、 - 単純
リターンやパラメータはなく、サマリーもありません
-O、 - 一
XNUMX 列の出力レイアウト
- ごみ デバッグ出力ダンプ
- フィルター
(デフォルトはなし) Lua データとして出力をフィルターします (例: pl.pretty.dump)
-タグ (デフォルトはなし) 指定されたタグへのすべての参照をカンマ区切りで表示します。
(文字列) ソース ファイルまたはソースを含むディレクトリ
例
ldoc . 同じディレクトリ内の config.ld ファイルからオプションを読み取ります
ldoc -c パス/to/myconfig.ld .
path/to/myconfig.ld からオプションを読み取ります
onworks.net サービスを使用してオンラインで ldoc を使用する