2.8.10 Generating MySQL Doxygen Documentation Content — MySQL 8.4

2.8.10 Генерация документации MySQL Doxygen

Исходный код MySQL содержит внутреннюю документацию, написанную с использованием Doxygen. Сгенерированная документация Doxygen доступна по адресу https://dev.mysql.com/doc/index-other.html. Также возможно сгенерировать эту документацию локально из дистрибутива исходного кода MySQL, следуя данной процедуре:

Установите doxygen версии 1.9.2 или выше. Дистрибутивы доступны здесь: http://www.doxygen.nl/.

После установки doxygen, проверьте версию:
```
$> doxygen --version
1.9.2
```
Установите PlantUML.

При установке PlantUML на Windows (тестировалось на Windows 10), необходимо запустить его как минимум один раз от имени администратора, чтобы создать необходимые ключи реестра. Откройте консоль администратора и выполните эту команду:
```
$> java -jar path-to-plantuml.jar
```
Команда должна открыть окно графического интерфейса и не выдать ошибок в консоли.
Установите переменную окружения PLANTUML_JAR_PATH в расположение, куда вы установили PlantUML. Например:
```
$> export PLANTUML_JAR_PATH=path-to-plantuml.jar
```
Установите утилиту Graphviz dot.

После установки Graphviz, проверьте доступность dot. Например:
```
$> which dot
/usr/bin/dot

$> dot -V
dot - graphviz version 2.40.1 (20161225.0304)
```
Перейдите в корневую директорию вашего дистрибутива исходного кода MySQL и выполните следующие действия:

Сначала выполните cmake:
```
$> cd mysql-source-directory
$> mkdir build
$> cd build
$> cmake ..
```
Затем сгенерируйте документацию doxygen:
```
$> make doxygen
```
Проверьте лог ошибок, который доступен в файле doxyerror.log в корневой директории. Предполагая, что сборка прошла успешно, просмотрите сгенерированный вывод в браузере. Например:
```
$> firefox doxygen/html/index.html
```