FindDoxygen

Doxygen — это инструмент генерации документации (см. http://www.doxygen.org). Этот модуль ищет Doxygen и некоторые дополнительные поддерживаемые им инструменты. Эти инструменты включены в качестве компонентов в команде find_package():

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.

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

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

Функции

doxygen_add_docs

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

doxygen_add_docs(targetName
    [filesOrDirs...]
    [WORKING_DIRECTORY dir]
    [COMMENT comment])

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

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

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

Содержимое сгенерированного 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 в требуемый формат, если она задана.

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

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

Для совместимости с предыдущими версиями 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.