戻る

プログラムからの標準ドックレットの実行
http://java.sun.com/j2se/1.5.0/ja/docs/ja/guide/javadoc/standard-doclet.html

Eclipseのメニューから JavaDocを生成する方法は

[メニューバー]→[プロジェクト]→[JavaDocの生成]
JavaDocを生成するプロジェクトを選択して作成する

関係するオプションが三つある

http://java.sun.com/j2se/1.5.0/ja/docs/ja/tooldocs/windows/javadoc.html#charset

-encoding UTF-8 ソースコードは UTF8 だ
-docencoding SJIS Javadoc HTMLの エンコードは SJISにする
-charset SJIS HTMLの先頭 に charset=SJIS を 埋め込む

-encoding UTF-8 -docencoding SJIS -charset SJIS
このようにすると、UTF8のソースを、SJISベースで JavaDocを生成する

-encoding UTF-8 -docencoding UTF-8 -charset UTF-8
このようにすると、UTF8のソースを、SJISベースで JavaDocを生成する

サンプルのドックレットを用意してみた

import com.sun.javadoc.*;

/*
 *
 * ドックレットである。
 * http://java.sun.com/j2se/1.5.0/ja/docs/ja/guide/javadoc/doclet/overview.html
 * このソースをコンパイルする為には、tools.jarを ビルドパスに登録する必要がある
 *
 */

public class ListClass {
    public static boolean start(RootDoc root) {
        ClassDoc[] classes = root.classes();
        for (int i = 0; i < classes.length; ++i) {
            System.out.println(classes[i]);
        }
        return true;
    }
}

標準ドックレットで コマンドプロントから流してみた

javadoc -encoding UTF-8 -docencoding UTF-8 -charset UTF-8 -d D:\Eclipse\workspace\JavaDoc用のプロジェクト\doc -sourcepath D:\Eclipse\workspace\JavaDoc用のプロジェクト\src testP

さっき作ったドックレットで流してみる

javadoc -encoding UTF-8 -doclet ListClass -docletpath D:\Eclipse\workspace\JavaDoc用のプロジェクト\bin\ -sourcepath D:\Eclipse\workspace\JavaDoc用のプロジェクト\src testP

使われないパラメタを指定すると、エラーになるようだ

なんとなく、わかったきたので、まとめてみる

やりたいことは、自分で作ったDocletをデバッグする→ ListClass

Javadocのメイン起動クラスを取り込む

package com.sun.tools.javadoc

これが、スタートクラスになる

自分の環境は、eclipse AllInOneだったので、逆コンパイラが付いていたので、jarの中もソースとして見れた^^

デバッグの構成を設定しておく

JavaDocをコマンドプロントで起動するイメージで、引数を切る

自分で作成したドックレット側にブレークポイントをいれておいた

めでたく、ブレークしてくれました。
変数のフォッチもできました

戻る