FindDoxygen

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

dot

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

mscgen

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

dia

Dia — редактор диаграмм, используемый командой Doxygen \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])

Функция строит 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(), используемой для создания пользовательской цели ввода.

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

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.