json-docletはJavadocツール用のDoclet。 標準Docletと違い、HTMLではなくJSONを吐き出します。
JSONでドキュメントを吐き出すため、アプリケーションからJavadocを利用することがHTMLに比べて容易です。 以下、その仕様をまとめます。 開発中のため、予告なく仕様は変更になる可能性があります。
許容する引数
-ofile (必須)
出力するファイル名を指定する。
-append
-ofileで指定されたファイルに追記する。
-pretty
JSONを出力時、整形された状態で出力する。
出力されるJSONオブジェクト
ルートオブジェクト
- classes - クラスオブジェクトの配列
クラスオブジェクト
name - クラスの正規名
interfaces - クラスが実装しているインタフェイスの正規名の配列
superclass - 親クラスの正規名
comment_text - クラスに付与されたJavadocコメント
since - @sinceタグの情報
see - @seeタグの情報を持つ配列
constructors - コンストラクタオブジェクトの配列
fields - フィールドオブジェクトの配列
methods - メソッドオブジェクトの配列
コンストラクタオブジェクト
name - コンストラクタメソッドの正規名
comment_text - メソッドに付与されたJavadocコメント
parameters - メソッドパラメータオブジェクトの配列
throws - 例外オブジェクトの配列
例外オブジェクト
name - 例外クラスの正規名
comment_text - @throwsタグに付与されたJavadocコメント
メソッドパラメータオブジェクト
name - 変数名
comment_text - @paramsタグに付与されたJavadocコメント
type - 型の正規名
フィールドオブジェクト
name - フィールド名
comment_text - フィールドに付与されたJavadocコメント
type - 型の正規名
メソッドオブジェクト
name - メソッドの正規名
comment_text - メソッドに付与されたJavadocコメント
parameters - メソッドパラメータオブジェクトの配列
throws - 例外オブジェクトの配列
return_type - メソッドから返却される型の正規名