整備 #4134
ドキュメント生成タブの「作成者・連絡先」情報がPROJECT_MAINTAINERにセットされるようにする
Start date:
07/04/2017
Due date:
% Done:
100%
Estimated time:
Description
- ドキュメント生成タブのページに「作成者・連絡先」の入力例をヒントとして表示する
- 入力書式は、 name <mail address>
- この情報はソースコードに入力される以外にdoxygenドキュメントとdebパッケージの Maintainer情報にも利用される
- このため名前はローマ字表記で、メールアドレスも<>記号で括る必要がある
- <>記号が抜けると、doxygenドキュメント生成時、正しいメールアドレスとして表記されないため
Associated revisions
Modified CMakeLists.txt #4134
Modified Hint in Document Tab #4134
Modified Hint in Document Tab #4134
History
#1 Updated by ga over 6 years ago
- Status changed from 新規 to 解決
- % Done changed from 0 to 100
ドキュメントタブのヒントに記述を追加させて頂きました．r749-752
｢作成者・連絡先｣が入力されている場合には，その内容をPROJECT_MAINTAINERに設定するように修正しました．
(入力されていない場合は，これまで通りunknownを設定)
#2 Updated by n.kawauchi over 6 years ago
ありがとうございました。下記の動作にて問題ないことを確認しました。
- 1) 「作成者・連絡先」入力が無い場合
- CMmakeLists.txtのPROJECT_MAINTAINERは、unknown
- 生成されるソースファイルのヘッダー部分にauther情報なし
- C++プロジェクトでdoxygenドキュメント生成時、**.h File Referenceページにauther情報なし
- debパッケージ生成時、debパッケージ情報のMaintainerはunknownとなる
- 例）
$ less py-test_1.0.0_amd64.deb : Maintainer: unknown
- 2)「作成者・連絡先」入力がある場合
- CMmakeLists.txtのPROJECT_MAINTAINERにセットされる
- 生成されるソースファイルのヘッダー部分にauther情報として挿入される
- C++プロジェクトでdoxygenドキュメント生成時、**.h File Referenceページにauther情報が記載される
- debパッケージ生成時、debパッケージ情報のMaintainerに反映される
- 例）
$ less py-test_1.0.0_amd64.deb : Maintainer: Kawauchi;Nobu;<n-kawauchi@openrtm.org>
- Windows用msiのプロパティ、rpmパッケージの情報には含まれない
#3 Updated by n-ando over 6 years ago
- Status changed from 解決 to 終了
Modified CMakeLists.txt #4134