FindDoxygen 以外の Doxygen の使い道

CMake Modules の FindDoxygen プログラミング解説

概要

FindDoxygen は、以下の情報を提供します。

• Doxygen の実行可能ファイルのパス
• Doxygen ヘッダーファイルのパス
• Doxygen 設定ファイルのパス

これらの情報は、CMake の他のモジュールやプロジェクトのビルド設定で使用できます。

使用方法

FindDoxygen を使用するには、CMakeLists.txt ファイルで以下のコマンドを実行します。

find_package(Doxygen)

FindDoxygen は、以下の変数を設定します。

• DOXYGEN_FOUND: Doxygen が見つかったかどうかを示すブール値
• DOXYGEN_EXECUTABLE: Doxygen 実行可能ファイルのパス
• DOXYGEN_INCLUDE_DIR: Doxygen ヘッダーファイルのパス
• DOXYGEN_CONFIG_DIR: Doxygen 設定ファイルのパス

これらの変数は、以下の例のように使用できます。

if(DOXYGEN_FOUND)
  add_custom_target(docs
    COMMAND ${DOXYGEN_EXECUTABLE}
    -o docs
    ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile
    )
endif()

FindDoxygen の詳細については、以下のリソースを参照してください。

補足

• FindDoxygen は、デフォルトで Doxygen のバージョン 1.8.13 を探します。異なるバージョンを使用している場合は、DOXYGEN_VERSION 変数を設定する必要があります。
• FindDoxygen は、いくつかのオプションを提供しています。詳細は、CMake ドキュメントを参照してください。

例

以下の例は、FindDoxygen を使用して Doxygen ドキュメントを生成する方法を示しています。

cmake_minimum_required(VERSION 3.10)

project(MyProject)

find_package(Doxygen)

if(DOXYGEN_FOUND)
  add_custom_target(docs
    COMMAND ${DOXYGEN_EXECUTABLE}
    -o docs
    ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile
    )
endif()

この例では、Doxygen モジュールを検索し、DOXYGEN_FOUND 変数が設定されているかどうかを確認します。DOXYGEN_FOUND が true の場合、docs という名前のカスタムターゲットを作成します。このターゲットは、Doxygen 実行可能ファイルを実行して、Doxyfile で指定されたドキュメントを生成します。

FindDoxygen は、CMake プロジェクトで Doxygen を簡単に使用するための便利なモジュールです。このモジュールを使用することで、Doxygen のインストール場所を自動的に検出し、ドキュメントを生成することができます。

FindDoxygen のサンプルコード

基本的な例

cmake_minimum_required(VERSION 3.10)

project(MyProject)

find_package(Doxygen)

if(DOXYGEN_FOUND)
  add_custom_target(docs
    COMMAND ${DOXYGEN_EXECUTABLE}
    -o docs
    ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile
    )
endif()

Doxygen バージョンの指定

cmake_minimum_required(VERSION 3.10)

project(MyProject)

set(DOXYGEN_VERSION 1.9.2)

find_package(Doxygen)

if(DOXYGEN_FOUND)
  add_custom_target(docs
    COMMAND ${DOXYGEN_EXECUTABLE}
    -o docs
    ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile
    )
endif()

この例では、DOXYGEN_VERSION 変数を設定して、Doxygen のバージョン 1.9.2 を検索します。

Doxygen オプションの指定

cmake_minimum_required(VERSION 3.10)

project(MyProject)

find_package(Doxygen)

if(DOXYGEN_FOUND)
  add_custom_target(docs
    COMMAND ${DOXYGEN_EXECUTABLE}
    -o docs
    -D DOXYGEN_QUIET=YES
    ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile
    )
endif()

この例では、DOXYGEN_QUIET オプションを設定して、Doxygen の出力を抑制します。

詳細なサンプル

以下のサンプルコードは、FindDoxygen を使用して Doxygen ドキュメントを生成する方法を示しています。

cmake_minimum_required(VERSION 3.10)

project(MyProject)

# Doxygen バージョンを指定
set(DOXYGEN_VERSION 1.9.2)

# Doxygen オプションを指定
set(DOXYGEN_WARN_IF_UNDOCUMENTED=YES)
set(DOXYGEN_JAVADOC_AUTOBRIEF=NO)

# Doxygen のインストール場所を指定
set(DOXYGEN_DIR /usr/local/bin)

# Doxygen モジュールを検索
find_package(Doxygen)

if(DOXYGEN_FOUND)
  # Doxygen ドキュメントを生成するカスタムターゲットを作成
  add_custom_target(docs
    COMMAND ${DOXYGEN_EXECUTABLE}
    -o docs
    -D DOXYGEN_QUIET=YES
    ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile
    )
else()
  message(STATUS "Doxygen が見つかりません。")
endif()

このサンプルコードでは、以下の設定を行っています。

• Doxygen バージョンを 1.9.2 に指定
• Doxygen オプションを設定
• Doxygen のインストール場所を指定

これらの設定は、find_package(Doxygen) コマンドの前に設定する必要があります。

FindDoxygen は、CMake プロジェクトで Doxygen を簡単に使用するための便利なモジュールです。このモジュールを使用することで、Doxygen のインストール場所を自動的に検出し、ドキュメントを生成することができます。

上記のサンプルコードを参考に、自分のプロジェクトに FindDoxygen を導入してみてください。

FindDoxygen 以外の Doxygen の使い道

CMake の Doxygen ターゲット

CMake は、Doxygen ドキュメントを生成するためのターゲットをいくつか提供しています。これらのターゲットを使用するには、CMakeLists.txt ファイルで以下のコマンドを実行します。

add_doxygen_target(docs
  INPUT_DIR ${CMAKE_CURRENT_SOURCE_DIR}
  OUTPUT_DIR docs
  )

このコマンドは、docs という名前の Doxygen ターゲットを作成します。このターゲットは、CMAKE_CURRENT_SOURCE_DIR ディレクトリにあるソースファイルから Doxygen ドキュメントを生成し、docs ディレクトリに出力します。

Doxygen は、コマンドラインツールとして使用することもできます。このツールを使用するには、以下のコマンドを実行します。

doxygen Doxyfile

このコマンドは、Doxyfile で指定された設定に基づいて Doxygen ドキュメントを生成します。

Doxygen は、GUI ツールとしても使用できます。このツールを使用するには、Doxygen を起動し、プロジェクトの設定を指定します。

その他の方法

上記の以外にも、Doxygen を使用するにはいくつかの方法があります。詳細は、Doxygen の公式ドキュメントを参照してください。

FindDoxygen は、CMake プロジェクトで Doxygen を使用する最も簡単な方法ですが、他にもいくつかの方法があります。自分のプロジェクトに合った方法を選択してください。