SystemC2.3にDoxygenつかってみた。

Doxygen」をインストールしたので、
SystemC 2.3のライブラリにやってみました。

実行までのながれ


$> doxygen -g doxygen.conf
$> vim doxygen.conf
$> doxygen doxygen.conf
実行に、「html」と「latex」というディレクトリができる。
「html」だと約230MBほどだった。

設定した内容


Doxyfile:Default, doxygen.conf:修正したもの
SystemC2.3のソースの場所は任意で。
--- Doxyfile    2012-09-14 06:48:58.000000000 +0900
+++ doxygen.conf    2012-09-14 06:42:14.000000000 +0900
@@ -26,13 +26,13 @@
 # identify the project. Note that if you do not use Doxywizard you need
 # to put quotes around the project name if it contains spaces.
 
-PROJECT_NAME           = "My Project"
+PROJECT_NAME           = "SystemC"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # This could be handy for archiving the generated documentation or
 # if some version control system is used.
 
-PROJECT_NUMBER         =
+PROJECT_NUMBER         = "2.3"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer
@@ -52,7 +52,7 @@
 # If a relative path is entered, it will be relative to the location
 # where doxygen was started. If left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       =
+OUTPUT_DIRECTORY       = "./"
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
 # 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -346,12 +346,12 @@
 # Private class members and static file members will be hidden unless
 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
 
-EXTRACT_ALL            = NO
+EXTRACT_ALL            = YES
 
 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
 # will be included in the documentation.
 
-EXTRACT_PRIVATE        = NO
+EXTRACT_PRIVATE        = YES
 
 # If the EXTRACT_STATIC tag is set to YES all static members of a file
 # will be included in the documentation.
@@ -648,7 +648,7 @@
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  =
+INPUT                  = /usr/local/src/systemc-2.3.0/src /usr/local/src/systemc-2.3.0/src/tlm_core /usr/local/src/systemc-2.3.0/src/tlm_core/tlm_2 /usr/local/src/systemc-2.3.0/src/tlm_core/tlm_2/tlm_sockets /usr/local/src/systemc-2.3.0/src/tlm_core/tlm_2/tlm_quantum /usr/local/src/systemc-2.3.0/src/tlm_core/tlm_2/tlm_2_interfaces /usr/local/src/systemc-2.3.0/src/tlm_core/tlm_2/tlm_generic_payload /usr/local/src/systemc-2.3.0/src/tlm_core/tlm_1 /usr/local/src/systemc-2.3.0/src/tlm_core/tlm_1/tlm_analysis /usr/local/src/systemc-2.3.0/src/tlm_core/tlm_1/tlm_req_rsp /usr/local/src/systemc-2.3.0/src/tlm_core/tlm_1/tlm_req_rsp/tlm_ports /usr/local/src/systemc-2.3.0/src/tlm_core/tlm_1/tlm_req_rsp/tlm_1_interfaces /usr/local/src/systemc-2.3.0/src/tlm_core/tlm_1/tlm_req_rsp/tlm_channels /usr/local/src/systemc-2.3.0/src/tlm_core/tlm_1/tlm_req_rsp/tlm_channels/tlm_fifo /usr/local/src/systemc-2.3.0/src/tlm_core/tlm_1/tlm_req_rsp/tlm_channels/tlm_req_rsp_channels /usr/local/src/systemc-2.3.0/src/tlm_core/tlm_1/tlm_req_rsp/tlm_adapters /usr/local/src/systemc-2.3.0/src/tlm_utils /usr/local/src/systemc-2.3.0/src/sysc /usr/local/src/systemc-2.3.0/src/sysc/packages /usr/local/src/systemc-2.3.0/src/sysc/packages/boost /usr/local/src/systemc-2.3.0/src/sysc/packages/boost/detail /usr/local/src/systemc-2.3.0/src/sysc/packages/boost/bind /usr/local/src/systemc-2.3.0/src/sysc/packages/boost/utility /usr/local/src/systemc-2.3.0/src/sysc/packages/boost/config /usr/local/src/systemc-2.3.0/src/sysc/packages/boost/config/compiler /usr/local/src/systemc-2.3.0/src/sysc/packages/boost/config/platform /usr/local/src/systemc-2.3.0/src/sysc/packages/boost/config/stdlib /usr/local/src/systemc-2.3.0/src/sysc/packages/boost/mpl /usr/local/src/systemc-2.3.0/src/sysc/packages/boost/mpl/aux_ /usr/local/src/systemc-2.3.0/src/sysc/packages/boost/mpl/aux_/config /usr/local/src/systemc-2.3.0/src/sysc/tracing /usr/local/src/systemc-2.3.0/src/sysc/communication /usr/local/src/systemc-2.3.0/src/sysc/datatypes /usr/local/src/systemc-2.3.0/src/sysc/datatypes/fx /usr/local/src/systemc-2.3.0/src/sysc/datatypes/misc /usr/local/src/systemc-2.3.0/src/sysc/datatypes/int /usr/local/src/systemc-2.3.0/src/sysc/datatypes/bit /usr/local/src/systemc-2.3.0/src/sysc/kernel /usr/local/src/systemc-2.3.0/src/sysc/utils /usr/local/src/systemc-2.3.0/src/sysc/qt /usr/local/src/systemc-2.3.0/src/sysc/qt/md /usr/local/src/systemc-2.3.0/src/sysc/qt/time
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -1597,7 +1597,7 @@
 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
 # have no effect if this option is set to NO (the default)
 
-HAVE_DOT               = NO
+HAVE_DOT               = YES
 
 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
 # allowed to run in parallel. When set to 0 (the default) doxygen will

Doxygen出力の例



20120914_doxygen_sc23_1.png

20120914_doxygen_sc23_2.png

環境


・Ubuntu12.04 LTS(VirtualBox上)
・Doxygen - 1.7.6.1

参考


Doxygen を使おう
超簡単なDoxygenの使い方
Windowsでdoxygenを使ってみる - よしなしごと
関連記事

コメントの投稿

非公開コメント

プロフィール

Kocha

Author:Kocha
なんでもチャレンジ!(^o^)/
E-mail
github:Kocha
イベントカレンダー

カレンダー
10 | 2017/11 | 12
- - - 1 2 3 4
5 6 7 8 9 10 11
12 13 14 15 16 17 18
19 20 21 22 23 24 25
26 27 28 29 30 - -
カテゴリ
OVP (4)
最新記事
最新コメント
アーカイブ
リンク
Twitter
アクセス人数