FindDoxygen

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

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.

Модуль определяет 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 удаляет рабочую директорию из относительных путей в сгенерированной документации (подробнее см. параметр конфигурации 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

Существуют ситуации, когда может быть нежелательно автоматическое заключение в кавычки определённого параметра конфигурации doxygen_add_docs(), например, ALIASES, которые могут потребовать собственных вложенных кавычек. Переменная DOXYGEN_VERBATIM_VARS может использоваться для задания списка переменных Doxygen (включая префикс DOXYGEN_ ), которые не должны заключаться в кавычки. Проект отвечает за то, чтобы значения этих переменных имели смысл, когда они непосредственно помещены в файл входных данных Doxygen. В случае переменных списков элементы списка всё ещё разделяются пробелами, это только автоматическое заключение в кавычки пропускается. Например, следующее позволяет doxygen_add_docs() применять кавычки к DOXYGEN_PROJECT_BRIEF, но не к каждому элементу в списке DOXYGEN_ALIASES (синтаксис в скобках также может быть использован для облегчения работы со вложенными кавычками):

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.