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 config option для получения подробностей).

Если указан, необязательный параметр 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's dot.