FindDoxygen

Doxygen — это инструмент для генерации документации (см. https://www.doxygen.nl). Этот модуль ищет Doxygen и некоторые поддерживаемые им необязательные инструменты:

dot

Graphviz dot утилита, используемая для рендеринга различных графиков.

mscgen

Message Chart Generator утилита, используемая командами Doxygen's \msc и \mscfile.

dia

Dia — редактор диаграмм, используемый командой Doxygen's \diafile.

# Require dot, treat the other components as optional
find_package(Doxygen
             REQUIRED dot
             OPTIONAL_COMPONENTS mscgen dia)

Следующие переменные определяются этим модулем:

DOXYGEN_FOUND

Истина, если исполняемый файл doxygen был найден.

DOXYGEN_VERSION

Версия, сообщенная doxygen --version.

Doxygen::doxygen
Doxygen::dot
Doxygen::mscgen
Doxygen::dia

Функции

doxygen_add_docs

Добавлен в версии 3.9.

Эта функция предназначена для удобства добавления цели для генерации документации с помощью Doxygen. Она нацелена на предоставление разумных значений по умолчанию, чтобы проекты могли в основном просто предоставить входные файлы и каталоги, и этого будет достаточно для получения разумных результатов. Функция поддерживает возможность настройки конфигурации Doxygen, используемой для построения документации.

doxygen_add_docs(targetName
    [filesOrDirs...]
    [ALL]
    [USE_STAMP_FILE]
    [WORKING_DIRECTORY dir]
    [COMMENT comment]
    [CONFIG_FILE filename])

Функция создает Doxyfile и определяет пользовательскую цель, которая выполняет Doxygen для этого сгенерированного файла. Перечисленные файлы и каталоги используются в качестве INPUT сгенерированной Doxyfile и они могут содержать подстановки. Любые файлы, которые явно перечислены, также будут добавлены в качестве SOURCES пользовательской цели, так что они будут отображаться в списке исходных файлов проекта IDE.

Для того, чтобы относительные пути к входу работали как ожидается, по умолчанию рабочая директория команды Doxygen будет текущей директорией исходного кода (т. е. CMAKE_CURRENT_SOURCE_DIR). Это можно переопределить с помощью параметра WORKING_DIRECTORY для изменения директории, используемой в качестве относительной базовой точки. Обратите также внимание на то, что Doxygen по умолчанию удаляет рабочую директорию из относительных путей в сгенерированной документации (см. STRIP_FROM_PATH параметр конфигурации Doxygen для получения подробной информации).

Если предоставлен, необязательный comment будет передан как COMMENT для команды add_custom_target(), используемой для создания пользовательской цели внутри.

Добавлен в версии 3.27: Если CONFIG_FILE задан, указанный файл с полным путем будет использоваться в качестве файла конфигурации doxygen.

Добавлен в версии 3.12: Если ALL задан, цель будет добавлена в стандартную целевую сборку.

Добавлен в версии 3.16: Если USE_STAMP_FILE задан, пользовательская команда, определенная этой функцией, создаст файл метки с именем <targetName>.stamp в текущей директории двоичных файлов всякий раз, когда doxygen выполняется повторно. При наличии этого параметра все элементы в <filesOrDirs> должны быть файлами (т. е. без каталогов, символических ссылок или подстановок), и каждый из файлов должен существовать в момент вызова doxygen_add_docs(). Возникнет ошибка, если любой из перечисленных элементов отсутствует или не является файлом, когда предоставляется USE_STAMP_FILE. Будет создана зависимость от каждого из файлов, так что doxygen будет выполняться повторно только в том случае, если один из файлов обновлен. Без параметра USE_STAMP_FILE, doxygen всегда будет выполняться повторно, если цель <targetName> построена, независимо от того, изменились ли какие-либо элементы, перечисленные в <filesOrDirs>.

Содержимое сгенерированного Doxyfile может быть настраиваемым путем задания переменных CMake перед вызовом doxygen_add_docs(). Любая переменная с именем в формате DOXYGEN_<tag> будет подставлена в соответствующий параметр конфигурации <tag> в Doxyfile. Обратитесь к документации Doxygen для получения полного списка поддерживаемых параметров конфигурации.

Некоторые значения Doxygen по умолчанию переопределяются для обеспечения более подходящего поведения для проекта CMake. Каждый из следующих элементов будет явно задан, если переменная уже не имеет значения перед вызовом doxygen_add_docs(), за исключением некоторых случаев:

DOXYGEN_HAVE_DOT

Устанавливается в YES если компонент dot был запрошен и найден, NO в противном случае. Любое существующее значение DOXYGEN_HAVE_DOT игнорируется.

DOXYGEN_DOT_MULTI_TARGETS

Устанавливается в YES этим модулем (обратите внимание, что это требует версии dot новее 1.8.10). Этот параметр имеет смысл только в том случае, если DOXYGEN_HAVE_DOT также установлено в YES.

DOXYGEN_GENERATE_LATEX

Устанавливается в NO этим модулем.

DOXYGEN_WARN_FORMAT

Для генераторов на основе Visual Studio это устанавливается в формат, распознаваемый IDE Visual Studio: $file($line) : $text. Для всех других генераторов значение по умолчанию Doxygen не переопределяется.

DOXYGEN_PROJECT_NAME

Заполняется именем текущего проекта (т. е. PROJECT_NAME).

DOXYGEN_PROJECT_NUMBER

Заполняется версией текущего проекта (т. е. PROJECT_VERSION).

DOXYGEN_PROJECT_BRIEF

Заполняется описанием текущего проекта (т. е. PROJECT_DESCRIPTION).

DOXYGEN_INPUT

Проекты не должны устанавливать эту переменную. Она будет заполнена набором файлов и каталогов, переданных doxygen_add_docs(), обеспечивая тем самым согласованное поведение с другими встроенными командами, такими как add_executable(), add_library() и add_custom_target(). Если переменная с именем DOXYGEN_INPUT установлена проектом, она будет проигнорирована, и будет выведено предупреждение.

DOXYGEN_RECURSIVE

Устанавливается в YES этим модулем.

DOXYGEN_EXCLUDE_PATTERNS

Если набор входов включает каталоги, эта переменная укажет шаблоны, используемые для исключения файлов из них. Следующие шаблоны добавляются doxygen_add_docs() для обеспечения того, чтобы файлы и каталоги, специфичные для CMake, не включались в ввод. Если проект устанавливает DOXYGEN_EXCLUDE_PATTERNS, эти данные объединяются с этими дополнительными шаблонами, а не заменяют их:

*/.git/*
*/.svn/*
*/.hg/*
*/CMakeFiles/*
*/_CPack_Packages/*
DartConfiguration.tcl
CMakeLists.txt
CMakeCache.txt

DOXYGEN_OUTPUT_DIRECTORY

Устанавливается в CMAKE_CURRENT_BINARY_DIR этим модулем. Обратите внимание, что если проект предоставляет своё значение для этого и это относительный путь, он будет преобразован в абсолютный путь, относящийся к текущей директории двоичных файлов. Это необходимо, потому что doxygen обычно выполняется из каталога в дереве исходного кода, чтобы относительные пути к исходному коду работали как ожидается. Если этот каталог не существует, он будет рекурсивно создан до выполнения команд doxygen.

Для изменения любого из этих значений по умолчанию или переопределения любого другого параметра конфигурации Doxygen, установите соответствующие переменные перед вызовом doxygen_add_docs(). Например:

set(DOXYGEN_GENERATE_HTML NO)
set(DOXYGEN_GENERATE_MAN YES)

doxygen_add_docs(
    doxygen
    ${PROJECT_SOURCE_DIR}
    COMMENT "Generate man pages"
)

Ряд параметров конфигурации Doxygen принимает списки значений, но Doxygen требует, чтобы они были разделены пробелами. Переменные CMake хранят списки в виде строки, где элементы разделены точками с запятой, поэтому необходимо выполнить преобразование. Команда doxygen_add_docs() конкретно проверяет следующие параметры конфигурации Doxygen и преобразует содержимое связанной переменной CMake в требуемый формат, если она установлена. Переменные CMake имеют имена DOXYGEN_<name> для параметров настроек Doxygen, указанных здесь.

ABBREVIATE_BRIEF
ALIASES
CITE_BIB_FILES
DIAFILE_DIRS
DOTFILE_DIRS
DOT_FONTPATH
ENABLED_SECTIONS
EXAMPLE_PATH
EXAMPLE_PATTERNS
EXCLUDE
EXCLUDE_PATTERNS
EXCLUDE_SYMBOLS
EXPAND_AS_DEFINED
EXTENSION_MAPPING
EXTRA_PACKAGES
EXTRA_SEARCH_MAPPINGS
FILE_PATTERNS
FILTER_PATTERNS
FILTER_SOURCE_PATTERNS
HTML_EXTRA_FILES
HTML_EXTRA_STYLESHEET
IGNORE_PREFIX
IMAGE_PATH
INCLUDE_FILE_PATTERNS
INCLUDE_PATH
INPUT
LATEX_EXTRA_FILES
LATEX_EXTRA_STYLESHEET
MATHJAX_EXTENSIONS
MSCFILE_DIRS
PLANTUML_INCLUDE_PATH
PREDEFINED
QHP_CUST_FILTER_ATTRS
QHP_SECT_FILTER_ATTRS
STRIP_FROM_INC_PATH
STRIP_FROM_PATH
TAGFILES
TCL_SUBST

Следующие параметры Doxygen с одним значением будут автоматически заключены в кавычки, если они содержат хотя бы один пробел:

CHM_FILE
DIA_PATH
DOCBOOK_OUTPUT
DOCSET_FEEDNAME
DOCSET_PUBLISHER_NAME
DOT_FONTNAME
DOT_PATH
EXTERNAL_SEARCH_ID
FILE_VERSION_FILTER
GENERATE_TAGFILE
HHC_LOCATION
HTML_FOOTER
HTML_HEADER
HTML_OUTPUT
HTML_STYLESHEET
INPUT_FILTER
LATEX_FOOTER
LATEX_HEADER
LATEX_OUTPUT
LAYOUT_FILE
MAN_OUTPUT
MAN_SUBDIR
MATHJAX_CODEFILE
MSCGEN_PATH
OUTPUT_DIRECTORY
PERL_PATH
PLANTUML_JAR_PATH
PROJECT_BRIEF
PROJECT_LOGO
PROJECT_NAME
QCH_FILE
QHG_LOCATION
QHP_CUST_FILTER_NAME
QHP_VIRTUAL_FOLDER
RTF_EXTENSIONS_FILE
RTF_OUTPUT
RTF_STYLESHEET_FILE
SEARCHDATA_FILE
USE_MDFILE_AS_MAINPAGE
WARN_FORMAT
WARN_LOGFILE
XML_OUTPUT

set(DOXYGEN_PROJECT_BRIEF "String with spaces")
set(DOXYGEN_ALIASES
    [[somealias="@some_command param"]]
    "anotherAlias=@foobar"
)
set(DOXYGEN_VERBATIM_VARS DOXYGEN_ALIASES)

Получившийся Doxyfile будет содержать следующие строки:

PROJECT_BRIEF = "String with spaces"
ALIASES       = somealias="@some_command param" anotherAlias=@foobar

Устаревшие переменные результатов

Для совместимости с предыдущими версиями CMake также определены следующие переменные, но они устарели и больше не должны использоваться:

DOXYGEN_EXECUTABLE

Путь к команде doxygen. Если проектам нужно напрямую обратиться к исполняемому файлу doxygen, они должны использовать импортированный целевой объект Doxygen::doxygen вместо этого.

DOXYGEN_DOT_FOUND

Истина, если исполняемый файл dot был найден.

DOXYGEN_DOT_EXECUTABLE

Путь к команде dot. Если проектам нужно напрямую обратиться к исполняемому файлу dot, они должны использовать импортированный целевой объект Doxygen::dot вместо этого.

DOXYGEN_DOT_PATH

Путь к каталогу, содержащему исполняемый файл dot, как указано в DOXYGEN_DOT_EXECUTABLE. Путь может содержать косые черты даже в Windows и не подходит для непосредственного подстановки в шаблон Doxyfile.in. Если вам нужно это значение, получите свойство IMPORTED_LOCATION целевого объекта Doxygen::dot и используйте get_filename_component() для извлечения каталога из этого пути. Также следует рассмотреть использование file(TO_NATIVE_PATH) для подготовки пути к файлу конфигурации Doxygen.

Устаревшие переменные подсказок

DOXYGEN_SKIP_DOT

Эта переменная не оказывает никакого влияния на компонентную форму find_package. В режиме обратной совместимости (т.е. без списка компонентов) она предотвращает поиск модулем поиска утилиты Graphviz dot.