Project

General

Profile

マニュアル #3969

Doxygenのタグファイルを生成する

Added by kanehiro almost 4 years ago. Updated over 3 years ago.

Status:
解決
Priority:
通常
Assignee:
Target version:
-
Start date:
02/26/2017
Due date:
% Done:

100%

Estimated time:

Description

Doxygenでドキュメントを生成する際に、タグファイルも生成して頂けると他のソフトウェアからも参照がしやすくなるのですがいかがでしょうか。

Associated revisions

Revision 3106 (diff)
Added by n-ando about 3 years ago

merged changes from trunk/OpenRTM-aist r3017, 3019, 3025-3026, 3028, 3030, 3032-3033 during 2017-08:
[compat,->RELENG_1_2] Support for 'stretch' has been added. refs #4164
[compat,->RELENG_1_2] Support for 'stretch' has been added. refs #4165
[compat,document,->RELENG_1_2] Doxyfile has been updated with the setting of doxygen 1.8.3.
[compat,build,->RELENG_1_2] Adding C/-p option to header install command. refs #4032
[compat,build,
>RELENG_1_2] Adding C/-p option to header install command. refs #4032
[compat,document,
>RELENG_1_2] Output tag file name has been added to doxyfile. refs #3969
[compat,document,->RELENG_1_2] Conf file generation in Makefile.am has been modified. refs #4173
[compat,document,->RELENG_1_2] Deleting unnecessary comment and tag files. refs #4173

Revision 3106 (diff)
Added by n-ando about 3 years ago

merged changes from trunk/OpenRTM-aist r3017, 3019, 3025-3026, 3028, 3030, 3032-3033 during 2017-08:
[compat,->RELENG_1_2] Support for 'stretch' has been added. refs #4164
[compat,->RELENG_1_2] Support for 'stretch' has been added. refs #4165
[compat,document,->RELENG_1_2] Doxyfile has been updated with the setting of doxygen 1.8.3.
[compat,build,->RELENG_1_2] Adding C/-p option to header install command. refs #4032
[compat,build,
>RELENG_1_2] Adding C/-p option to header install command. refs #4032
[compat,document,
>RELENG_1_2] Output tag file name has been added to doxyfile. refs #3969
[compat,document,->RELENG_1_2] Conf file generation in Makefile.am has been modified. refs #4173
[compat,document,->RELENG_1_2] Deleting unnecessary comment and tag files. refs #4173

History

#1 Updated by n.kawauchi over 3 years ago

  • Status changed from 新規 to 解決
  • % Done changed from 0 to 100

河内です。対応が遅くなってしまい申し訳ございません。

Doxygenでタグファイルを生成するdoxytagは、1.8.0版で廃止され、doxygenコマンドへ
統合されたようです。今回、doxygen1.8.3の設定ファイルを使いOpenRTM-aist1.2.0版の
ドキュメントを生成させてみました。 下記で確認できます。

http://staging.openrtm.org/pub/doc_1.2.0/cxx/
http://staging.openrtm.org/pub/doc_1.2.0/idl/

お気づきの点がございましたら、doxyfileの設定を変更します。
1.2.0版リリース後は、openrtm.org/doc へアップロードする予定です。

よろしくお願いいたします。

#2 Updated by kanehiro over 3 years ago

河内様、

タグファイルを生成するには、
GENERATE_TAGFILE =
のところでファイル名を指定する必要があろうかと思います。
よろしくお願いします。

#3 Updated by n.kawauchi over 3 years ago

金広様

河内です。

クラスリファレンスのドキュメントでタグファイル名をOpenRTM-aist.tagと指定して
生成してみました。このファイルの検証として使ってみようと思いましたが、
installdoxスクリプト(下記ページに説明されている)が見当たらず、出力しただけです。

http://www.doxygen.jp/doxytag_usage.html

生成したtagファイルは下記へ置きました。この内容でよろしいでしょうか。

http://staging.openrtm.org/pub/doc_1.2.0/OpenRTM-aist.tag

以上、よろしくお願いいたします。

#4 Updated by kanehiro over 3 years ago

河内様、

形式としてはこちらでよろしいかと思います。
内容としてはIDLに関する情報が入っていないようですので、含めて頂けますと助かります。

#5 Updated by n.kawauchi over 3 years ago

金広様

IDLのタグファイルもアップロードしました。
http://staging.openrtm.org/pub/doc_1.2.0/OpenRTM-aist-IDL.tag

クラスリファレンスとIDLは別々のドキュメントとしてdoxyfileを
定義しているため、tagファイルも別になりました。

以上、よろしくお願いいたします。

#6 Updated by kanehiro over 3 years ago

河内様、

ありがとうございます。
これらのタグファイルが設定されるようdoxygenの設定ファイルを更新して頂けますと助かります。

Also available in: Atom PDF