プロジェクト

全般

プロフィール

整備 #4135

doxygen設定ファイルdoxyfile.inを整備する

n.kawauchi がほぼ7年前に追加. 6年以上前に更新.

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

100%

予定工数:

説明

  • 下記の理由で設定を変更する
  • graphvizで生成される図のRTCのファイル名をフルパス表示にしない（STRIP_FROM_PATHを設定）
  • include, importのファイル名をフルパス表示にしない（STRIP_FROM_INC_PATH設定を変更）
  • Java/PythonのRTCの場合、言語により適合した出力形式にする（OPTIMIZE_OUTPUT_JAVA設定の切替え）
    • 名前空間はパッケージとして提示されるなど
  • Python RTCのドキュメントを生成できるようにする（FILE_PATTERNSへ追加）
  • RTCプロジェクトにShift-JISのソースがあった場合にnkfで自動変換し、文字化けしないようにする
    （INPUT_FILTER, FILTER_SOURCE_FILESを設定）
    • graphviz, nkfは一括インストールスクリプトでインストールされるように対応する
  • 修正内容は次の通り
    STRIP_FROM_PATH        =
　　↓
STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@
-----
STRIP_FROM_INC_PATH    = @PROJECT_SOURCE_DIR@/include
　　↓
STRIP_FROM_INC_PATH    = @PROJECT_SOURCE_DIR@
-----
OPTIMIZE_OUTPUT_JAVA   = NO　←★C++ならばこのままでよい
　　↓
OPTIMIZE_OUTPUT_JAVA   = YES　←★Python,Javaの場合はYESにする
-----
FILE_PATTERNS          = *.h \
                         *.hpp \
                         *.doxy
　　↓
FILE_PATTERNS          = *.h \
                         *.hpp \
                         *.py \
                         *.idl \
                         *.doxy
-----
INPUT_FILTER           =
　　↓
INPUT_FILTER           = "nkf -w" 
-----
FILTER_SOURCE_FILES    = NO
　　↓
FILTER_SOURCE_FILES    = YES

関係しているリビジョン

リビジョン 753 (差分)
ga がほぼ7年前に追加

Modified CMakeLists.txt #4135

履歴

#1 ga がほぼ7年前に更新

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

修正させて頂きました r753
OPTIMIZE_OUTPUT_JAVAの部分はC++の場合は｢NO｣，それ以外の言語の場合は｢YES｣を設定するようにしています

#2 n.kawauchi がほぼ7年前に更新

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

  • 1) C++とPythonの RTCを新規作成し、ドキュメントを生成する
    • C++とPythonではdoxyfile.inで１か所設定が異なり下のようにメニュー名が変わることを確認
    • ドキュメントメニュータブがC++は「Namespaces」、Pythonは「Packages」となる
  • 2) 既存プロジェクトのdoc/doxyfile.inを差し替えれば新しい設定でのドキュメントを生成できる
  • 3) RTCBuilderで生成されるソースファイルはUTF-8だが、既存のShift-JISのソースを加えたプロジェクトの
    ドキュメントを生成しても文字化けしない
    • nkfで変換しているため

#3 n-ando が6年以上前に更新

  • ステータス を 解決 から 終了 に変更

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