Help us understand the problem. What is going on with this article?

Eclipse+APIvizでjavadocにクラス図を出力

More than 3 years have passed since last update.

Eclipse環境にAPIvizを設定してJavaDocにクラス図を合わせて出力する。
前はdoxygen+graphvizでやってたが、何となくjavadocの方が出力したhtmlの見た目が好きなので。
ということでAPIvizを使ってみようと思ったのだがあまり日本語資料がないのでメモ。
でもAPIvizって2012で開発止まってるんだよなぁ。

実行環境

Windows8.1, Eclipse4.5(Pleiades All in One), Java1.8, APIviz1.3.2
※APIvizは必ず最新版(現時点:1.3.2)を使用してください。1.3.1より前はJDKのバージョンが合わないようでエラーが発生します。

インストール

  1. まず、APIvizにはGraphvizが必要なので下記サイトからダウンロード、インストール。サイトが停止している場合は日や時間を適当に調整。夜中やってたら停止してた・・・
    Graphviz - Graph Visualization Software

  2. 環境変数「Path」に、「<Graphvizインストールフォルダ>\bin」(dot.exeのあるフォルダ)を追加する。

  3. APIvizの最新版zipファイルを下記サイトからダウンロードし、任意のフォルダに展開する。(例-C:\work\ProgramFiles\apiviz)
    JavaDoc doclet for API visualization

環境設定

1. プロジェクト右クリック⇒エクスポート⇒Java⇒JavaDocを選択

2. 「カスタム・ドックレットを使用」を選択。下記設定を行い「次へ」ボタン押下

ドックレット名:org.jboss.apiviz.APIviz
ドックレットクラスパス:C:\work\ProgramFiles\apiviz\jar\apiviz-1.3.2.GA.jar

3. 「追加のJavaDocオプション」に以下を指定

 -encoding utf-8
 -charset utf-8
 -windowtitle サンプルプロジェクト ←javadocのタイトル。プロジェクト名とか指定する
 -sourceclasspath C:\work\workspace\sample\bin ←.classファイル出力フォルダパス
 -d C:\work\workspace\sample\doc\main ←javadoc出力先フォルダパス

※AntとかMaven2の設定は本家サイト(英語)に詳しい記載があるのでそちらを参照する事。

実際の出力

こんな感じで
image1.gif

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした