The following figure shows how tool between tools and tools between tools.
Doxygen Information Flow
Step 1: Create a configuration file
Doxygen uses a configuration file to determine all settings. Each project should have its own profile. A project can be composed of a single source file or a tree that is recursively scanned.
To simplify the creation of the configuration file, Doxygen can create a template profile for you. Use the -g parameter in the command line mode:
Doxygen -g
Parameter
The profile is very similar to the file format of Makeflie. It has a lot of Assignments (Tags) on the composition:
TAGNAME = value or tagname = value1 Value2 ...
Most TAGs in the generated template configuration file can use the default value. Refer to Configuration This chapter obtains a more detailed description of the profile.
If you don't want to use Notepad to manually edit the configuration file, then you have to study DoxyWizard, this exe is the Doxygen's GUI front desk, used to read and write the Doxygen configuration file and can set parameters by dialog box. For a small number of projects with a small amount of C / C files (.h, .cpp), you can even leave a blank at the Input, and Doxygen will automatically find the source file in the current directory. (I don't seem to use J)
If it is a big project, there is a source file directory or a tree directory, then it should be set in the Input and add one to multiple file pattern (for example, * .cpp * .h) at File_Patterns. Only if the file compliant with Pattern will be analyzed (if Pattern is not set, a source file extension list will be used). For recursive analysis source files, the Recursive must be set to YES (this is certain for the big project). If you need to make a further custom file list, you can use Exclude and Exclude_patterns. For example, to ignore all test engineering directories, you can do this (it seems very useful, many times specifically built an incrude directory, which is repeated with the files in the project):
EXCLUDE_PATTERNS = * / TEST / *
Doxygen usually analyzes the C / C source file. If a file is .IDL or .oDL, it will be considered an IDL file. If it is .java suffix, it will be considered a Java file. If it is a .cs suffix, it will be considered a C # file. Finally .php, php4, .inc or .phtml is considered to be a PHP file.
If you have an engine (notified by doxygen unknown), you can use the extract_all option. Such Doxygen will attempt to analyze all comments in the source code. Please not yes.
