Doxygen Documentation

From VideoLAN Wiki

One can reach the Doxygen documentation here.

To create a local copy of the documentation, use the Doxyfile provided in the doc/ directory of the source code. Note that you need doxygen and graphviz.

Also note that you may change some variables in the Doxygen file so as to create call graphs for the functions, which may be useful for understanding the relationship between files. One can use a GUI frontend such as doxywizard to change those Doxyfile parameters.

Additionally, one can use a GUI frontend to cscope like kscope to start analyzing the VLC code. Kscope contains features showing all references to a symbol, the definition of a symbol, all functions called by or calling to a function, an EGrep pattern, finding all files #including some file etc.