Project

General

Profile

整備 #4135

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

Added by n.kawauchi over 4 years ago. Updated about 4 years ago.

Status:
終了
Priority:
通常
Assignee:
Start date:
07/04/2017
Due date:
% Done:

100%

Estimated time:

Description

  • 下記の理由で設定を変更する
  • 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
    

Associated revisions

Revision 753 (diff)
Added by ga over 4 years ago

Modified CMakeLists.txt #4135

History

#1 Updated by ga over 4 years ago

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

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

#2 Updated by n.kawauchi over 4 years ago

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

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

#3 Updated by n-ando about 4 years ago

  • Status changed from 解決 to 終了

Also available in: Atom PDF