Generate MySQL Doxygen documentation content

#MySQL’s source code contains extensive internal documentation, which is written using Doxygen. This Doxygen content is available at https://dev.mysql.com/doc/index-other.html. This Doxygen content can be generated locally from the MySQl source distribution. This can be done by following the steps -

Install Doxygen

The first step is to install Doxygen 1.8.11 or higher. These distributions are available at http://www.doxygen.nl/.

After installation, the version number must be verified. This can be done using the following command -

shell > doxygen −−version
1.8.13

Install PlantUML

The next step is to install PlantUML. When it is installed on Windows 10, it should be run as administrator at least once so that registry keys can be created.

The administrator console can be opened and the following code needs to be executed -

shell> java −jar path−to−plantuml.jar

The above command will open a GUI window and the console will not display any errors.

After completing this step, you need to set the PLANTUML_JAR_PATH environment variable to the location of the PlantUML installation. Let’s see an example −

shell> export PLANTUML_JAR_PATH=path-to-plantuml.jar

Installing Graphviz

The next step is to install the Graphviz dot command.

After the installation is completed, you need to verify the availability of the dot command. This can be verified using the following command:

shell> which dot
/usr/bin/dot

shell> dot −V
dot − graphviz version 2.28.0 (20130928.0220)

The location of the top-level directory of the MySQL source code distribution must be changed. You can use the following command to make changes −

shell> cd your-mysql-source-directory
shell> mkdir bld
shell> cd bld
shell> cmake ..

First execute cmake.

Generate Doxygen documentation

The next step is to generate doxygen documentation. This can be done by executing the following command -

shell> make doxygen

Once you complete this step, you need to check the error log. The error log can be found in the doxyerror file in the top-level directory. Once the build executes successfully, the generated output can be viewed on the browser. This can be done using the following command −

shell> firefox doxygen/html/index.html

The above is the detailed content of Generate MySQL Doxygen documentation content. For more information, please follow other related articles on the PHP Chinese website!