One IT Thing

IT業界で飯を食う為の学習系雑記

java

Doxygenでspring-frameworkをドキュメント化

投稿日:2019年8月2日 更新日:

以前にspring-frameworkのソースリーディングが出来る環境をOpenGrokで作りました。

読んでいる最中にクラス関連や呼び出しをビジュアルに把握したくなったりするので、Doxygenを使って補足資料として生成しておきます。

実行環境

  • CentOS 7.6
  • Doxygen 1.8.5
  • graphviz 2.30.1-21

doxygen、graphvizインストール

# yum -y install doxygen
# yum -y install graphviz graphviz-gd

doxygenコマンド、graphvizのdotコマンドがインストールされたことを確認します。

# doxygen -v
1.8.5

# dot -v
dot - graphviz version 2.30.1 (20180420.1509)

Doxyfileを設定

doxygenでドキュメント生成する際はDoxyfileというファイルを作成します。最近のバージョンではdoxywizardコマンドでGUI設定出来たりしますが、ターミナル操作の想定でコマンドラインのみで設定していきます。

/tmpにspring-frameworkをgit cloneしてある状態です。

# cd /tmp
# git clone https://github.com/spring-projects/spring-framework.git
# cd spring-framework

Doxyfileを生成します。

]# doxygen -g


Configuration file `Doxyfile' created.

Now edit the configuration file and enter

  doxygen Doxyfile

to generate the documentation for your project

vi Doxyfile等で以下の箇所を変更してJavaプロジェクト向けの生成設定を行います。

PROJECT_NAME = "プロジェクト名"
PROJECT_NUMBER = "1.0.0などのバージョン"
OUTPUT_LANGUAGE = Japanese
JAVADOC_AUTOBRIEF = YES
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
RECURSIVE = YES
HAVE_DOT = YES
UML_LOOK = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
OPTIMIZE_OUTPUT_JAVA   = YES

ドキュメント生成開始

Doxyfileがあるディレクトリでdoxygenコマンドを実行するだけです。

# dogygen

生成された「html」ディレクトリをApacheなら/var/www/html/spring-frameworkなどにコピーして外部から参照出来るようにしておきます。

見れるか確認

http://HTTPサーバIP/spring-frameworkにブラウザでアクセスします。

クラス図。

コラボレーション図。

まとめ

ビジュアルなドキュメントが出来上がりました。

ソースリーディングのお供、他にも新規参画したプロジェクトの分析に使えますね。

-java
-,

執筆者:

関連記事

JavaとPerlでUDPソケット通信

目次1 はじめに2 対象読者3 実装3.1 UDPサーバ(Perl)3.2 UDPクライアント(Java)3.3 実行4 まとめ はじめに 本棚を整理していたらラクダ本が出てきました。うわー懐かしい、 …

StripeとJavaで単発Web決済を一通り流してみる

会社仕事でも個人ビジネスでも、商品やサービスの対価として利用者に課金方法を提供したい時があるかと思います。 最もメジャーな決済方法であるクレジットカードで課金してもらう仕組みを導入したいところですが、 …

Maven環境別ビルド時、プロファイルの違いでdependencyを変える

MavenのResourceFilteringを使い、production、staging、developmentとかで環境別ビルドしている時、ある環境ビルドの時だけ特定のライブラリを追加する、をmv …

SpringBootアプリにBootstrap4を追加(WebJars使用)

SpringBootにCSSやJSを追加する場合は概ね以下のパターンがあるんじゃないかと思います。(bowerはもう使わない方向で) CDNで外部から読み込む<script src=&#8221 …

IVS対応フォント「IPAmj明朝」で使えるフォントをWeb上に一覧表示してみる(1)

目次1 IPAmj明朝フォントとは2 日本における漢字のコンピュータ表示課題3 サロゲートペアが対応策だが4 IVS(ideographic variation sequence) とは5 そこでIP …

 

sin7k24
 

東京在勤、職歴20年越え中年ITエンジニアです。まだ開発現場で頑張っています。

19歳(1996年)から書き始めた個人日記が5,000日を超え、残りの人生は発信をして行きたいと思い、令和元日からこのサイトを開始しました。勉強と試行錯誤をしながら、自分が経験したIT関連情報を投稿しています。

私と同じく、今後IT業界で生計を立てて行きたいと考えている方や、技術共有したいけどフリーランスで孤独、といった方と一緒に成長、知識共有して行けたら楽しいな、と思っています。