プロジェクト

全般

プロフィール

操作
リンクをコピー

整備 #4134

完了

ドキュメント生成タブの「作成者・連絡先」情報がPROJECT_MAINTAINERにセットされるようにする

n.kawauchi さんが7年以上前に追加. 7年以上前に更新.

ステータス:
終了
優先度:
通常
担当者:
ga
対象バージョン:
OpenRTM-aist - RELEASE_1_2_0
開始日:
2017/07/04
期日:
進捗率:

100%

予定工数:

説明

  • ドキュメント生成タブのページに「作成者・連絡先」の入力例をヒントとして表示する
  • 入力書式は、 name <mail address>
  • この情報はソースコードに入力される以外にdoxygenドキュメントとdebパッケージの Maintainer情報にも利用される
  • このため名前はローマ字表記で、メールアドレスも<>記号で括る必要がある
  • <>記号が抜けると、doxygenドキュメント生成時、正しいメールアドレスとして表記されないため
操作
リンクをコピー
 #1

ga さんが7年以上前に更新

  • ステータス を 新規 から 解決 に変更
  • 進捗率 を 0 から 100 に変更

ドキュメントタブのヒントに記述を追加させて頂きました．r749-752
｢作成者・連絡先｣が入力されている場合には，その内容をPROJECT_MAINTAINERに設定するように修正しました．
(入力されていない場合は，これまで通りunknownを設定)

操作
リンクをコピー
 #2

n.kawauchi さんが7年以上前に更新

ありがとうございました。下記の動作にて問題ないことを確認しました。

  • 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

n-ando さんが7年以上前に更新

  • ステータス を 解決 から 終了 に変更
操作
リンクをコピー

他の形式にエクスポート: Atom PDF