background
In the Find ffmpeg document and found that the document is based on the Doxygen generated.
In order to facilitate learning, here to generate ffmpeg 4.1 document as an example.
Introduction to Doxygen
Official Website: http://www.doxygen.nl/index.html
Doxygen is a documentation generation tool program, the program can convert notes into the documentation or the API reference manual, thus reducing the time programmer finishing the document. Of course, this program annotations need to follow certain rules to write, to make Doxygen recognition and transformation.
Doxygen current programming language can handle comprising C / C ++, Java, Objective-C, IDL, etc., can be created out of document formats HTML, XML, LaTeX, RTF, in addition may be derived from a lot of other formats, such as HTML can packaged into CHM format, LaTeX tools that can produce PS or PDF documents.
Installation and use Doxygen
To install and use the following example Windwos
Installation list:
When you install, no special settings.
Doxygen : Download, http://doxygen.nl/files/doxygen-1.8.17-setup.exe
HTML Help: Microsoft officials used to generate HTML-formatted help file, Download, http://go.microsoft.com/fwlink/p/?linkid=14188
Graphviz : one kind of dot tool can be used to render better graphics, Download, https://graphviz.gitlab.io/_pages/Download/windows/graphviz-2.38.msi
Doxygen-based settings
Doxygen has a command line (CMD tool) tool and interface of (GUI) tool types. Common interface settings under Windows.
Open Doxywizard (Doxygen GUI fronted)
Fill in the following position based on the actual situation, click next.
Mode setting mode
In Select the desired extraction mode:
1. Select All Entities
2. MarkInclude cross-referenced source code in the ouput
inSelect programing languge the optimize the results for ：
According to the actual needs of the project to select the corresponding language
select:Optimize for C or PHP output
Click next.
Oputput set the output
InSelect the output format(s) to generate
1. Select HTML
2. Select:prepare for compressed HTML(.chm)
Uncheck Latex
Here we do not intend to use the tool LaTex output related documents.
Click next.
Diagrams set legend
In Diagrams to generate:
Select Use built-in class diagram generator
Check Dot graphs to generateunder all items