Download manual is provided
Transcript
Chapter 3 Getting Started The executable doxygen is the main program that parses the sources and generates the documentation. See section Doxygen usage for more detailed usage information. Optionally, the executable doxywizard can be used, which is a graphical front-end for editing the configuration file that is used by doxygen and for running doxygen in a graphical environment. For Mac OS X doxywizard will be started by clicking on the Doxygen application icon. The following figure shows the relation between the tools and the flow of information between them (it looks complex but that’s only because it tries to be complete): Doxywizard generate/edit Your application XML files read doxmlparser lib Config file Doxyfile Layout file make ps generate generate update read Latex files + Makefile postscript latex make pdf PDF read Sources custom output Doxygen read read generate Man pages Custom − headers − footers − images Tag file(s) Windows only refman.rtf HTML pages import read Figure 3.1: Doxygen information flow doc MS−Word chm HTML Help Workshop