2.9.10 Generating MySQL Doxygen Documentation Content

Contents

The MySQL source code contains internal documentation written using Doxygen. The generated Doxygen content is available at https://dev.mysql.com/doc/index-other.html. It is also possible to generate this content locally from a MySQL source distribution using the following procedure:

Install doxygen 1.8.11 or higher. Distributions are available here:
```
http://www.stack.nl/~dimitri/doxygen/download.html
```
After installing doxygen, verify the version number:
```
shell> doxygen --version
1.8.11
```
Install PlantUML. Distributions are available here:
```
http://plantuml.com/download.html
```
When you install PlantUML on Windows (tested on Windows 10), you must run it at least once as administrator so it creates the registry keys. Open an administrator console and run this command:
```
java -jar path-to-plantuml.jar
```
The command should open a GUI window and return no errors on the console.
Install the Graphviz dot command. Distributions are available here:
```
http://www.graphviz.org/
```
After installing Graphviz, verify dot availability. For example:
```
shell> which dot
/usr/bin/dot
shell> dot -V
dot - graphviz version 2.28.0 (20130928.0220)
```
Set the PLANTUML_JAR_PATH environment to the location where you installed PlantUML. For example:
```
export PLANTUML_JAR_PATH=path-to-plantuml.jar
```
To invoke doxygen, change location to the top-level directory of your MySQL source distribution and execute these commands:
```
mkdir -p generated/doxygen
doxygen
```
Inspect the error log. It is available in the doxyerror.log file in the top-level directory. Assuming that the build executed successfully, view the generated output using a browser. For example:
```
firefox generated/doxygen/html/index.html
```
You can use a different browser, and even bookmark the page.

Find a PHP function

Document created the 26/06/2006, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/mysql-rf-source-installation-doxygen.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

Manuel MySQL : https://dev.mysql.com/

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut