プロジェクト

全般

プロフィール

整備 #4135

完了

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

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

ステータス:
終了
優先度:
通常
担当者:
対象バージョン:
開始日:
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
    

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