If you start using doxygen for an existing project (thus without any documentation that doxygen is aware of), you can still get an idea of what the documented result would be. java extension it is treated as a file written in Java. odl extension it is treated as an IDL file. To omit all test directories from a source tree for instance, one could use:ĭoxygen normally parses files if they are C or C++ sources. To further fine-tune the list of files that is parsed the EXCLUDE and EXCLUDE_PATTERNS tags can be used. For recursive parsing of a source tree you must set the RECURSIVE tag to YES. Only files that match one of the patterns will be parsed (if the patterns are omitted a list of source extensions is used). If you have a larger project consisting of a source directory or tree you should put the root directory or directories after the INPUT tag, and add one or more file patterns to the FILE_PATTERNS tag (for instance *.cpp *.h).

If you do not wish to edit the config file with a text editor, you should have a look at doxywizard, which is a GUI front-end that can create, read and write doxygen configuration files, and allows setting configuration options by entering them via dialogs.įor a small project consisting of a few C and/or C++ source and header files, you can leave INPUT tag empty and doxygen will search for sources in the current directory. See section Configuration for more details about the configuration file. You can probably leave the values of most tags in a generated template configuration file to their default value. It contains of a number of assignments (tags) of the form: The configuration file has a format that is similar to that of a (simple) Makefile. the minus sign) as the file name then doxygen will try to read the configuration file from standard input ( stdin). bak before generating the configuration template. If a file with the name already exists, doxygen will rename it to. If you omit the file name, a file named Doxyfile will be created. Where is the name of the configuration file.

Doxygen makefile