petitviolet blog

    Android StudioでJavaDocを生成する

    2014-11-08

    QiitaJavaAndroid

    頑張って書いた JavaDoc を Android Studio から生成する手順

    環境

    Android Studio 0.8.6 jdk1.7.0_60.jdk

    手順

    メニューの[Tools] -> [Generate JavaDoc...]を選択

    スクリーンショット_2014-11-09_0_19_48.png

    JavaDoc を生成する Scope を選択

    初期状態

    初期状態はこんな感じのはず

    スクリーンショット 2014-11-09 0.28.51.png

    [Custom scope]の[...]を選択

    スクリーンショット_2014-11-09_0_28_51.png

    [+]ボタンを選択

    スクリーンショット 2014-11-09 0.27.10.png

    とりあえず[Local]で良いっぽい

    スクリーンショット 2014-11-09 0.27.18.png

    scope の名前を入れる

    何でもいいが、今回はappとした

    スクリーンショット 2014-11-09 0.27.29.png

    scope を作る

    JavaDoc を生成する scope を選択できるようになるので、 [Include]とか[Exclude]を使って scope を作る

    スクリーンショット 2014-11-09 0.21.12.png

    オプションの指定

    scope を設定して帰ってくるとこんな感じになる

    スクリーンショット 2014-11-09 0.23.42.png

    [Output directory]を指定する

    そのままで、生成した JavaDoc を保存する場所のこと

    スクリーンショット_2014-11-09_0_35_21.png

    実行のオプションを入力する

    場所は[Other command line arguments] 入力として

    -encoding UTF-8 -bootclasspath /path/to/android-sdks/platforms/android-21/android.jar

    今回は JavaDoc に日本語を使っていたこともあり、文字コードを指定している また、android.jarを指定しないと数多のエラーを吐いて死ぬので、sdk を置いてある場所からandroid.jarを探しだしてその PATH を-bootclasspathとして指定する

    スクリーンショット_2014-11-09_0_37_02_1.png

    これで OK

    ブラウザで勝手に JavaDoc が表示されるので楽しむ

    from: https://qiita.com/petitviolet/items/9c7a1d3cce58c4173a4c