Index.html file with a web browser to view the documentation. Inside the output folder or directly in the root folder, there willīe an html folder, with a file called index.html in it. For this project,Ī new folder called generated-docs will be created, but with the defaultĬonfiguration, the output will simply appear in the same folder as theĭoxyfile. Will look for source files, parse them, and generate output. To run doxygen, simply navigate to the project directory and run doxygen. This configuration file can be modified to change howĭoxygen runs, and each project has its own Doxyfile. A newĭoxyfile can be generated by using doxygen -g (leave theįilename blank normally). There is a file called Doxyfile that controls how Doxygen will run. Modify the Doxyfile's DOT_PATH variable to point to the path of the.Install the latest stable release of graphviz.Download and install Doxygen for Windows from the Doxygen website.If for some reason you are not using WSL, you can follow these steps to install If you use these, installing doxygen is as It is vastly superior to theĪvailable Windows command prompt and to alternatives like GitBash.

If you are using a Windows computer, you should be using Windows Subsystem for How to Install Doxygen WSL Installation Instructions AnĪutoformat.sh script is also provided for completeness. There is a run.sh file, which compiles the code and runs the result. There are a few example C++ files in the src/ directory. The Doxygen output for the project is available Set up as an example that shows how Doxygen can be used.įor more information about how Doxygen works, see the official Doxygen Doxygen is a tool that parses source code, finds specially-formatted comments,Īnd produces nice-looking documentation files out of them.

Ffmpeg documentation doxygen download