apiDoc を Java で使ってみたよ。
package.json を作る
こんな内容でもいいから package.json を作ってカレントディレクトリに置いておく。
package.json
{
"name": "Great API",
"version": "1.0.0",
"description": "すごいよ!!!"
}
オプションで java を明記する
apiDoc はデフォルトで js ファイルしか見ないので、-f オプションで java を見るように設定します。
apidoc -o apidoc -f ".*java$"
javadoc のアノテーションと混ぜない
/**
* @api {get} /search.json 検索します
* @return 結果のJSON
*/
こんな書き方をすると、return なんて知らん!って言われてしまいます。解決方法は以下のどちらか。
- 通常の javadoc はバッサリ切ってしまう
- apiDoc, javadoc の順で書く。メソッドの直前に javadoc を書いておくことで javadoc 的には OK