How to set an input directory for Doxygen?

Question

I have a directory in which all source and header files are saved. I would like to run Doxygen to generate documentation for these source code. However, I do not want to change anything in this directory (in particular I cannot add sub directories in which Doxygen documentation will be saved).

How can I achieve what I need?

I think I need to do the following: - I create and go to the 'documentation' directory. - In this directory I execute doxygen -g to create a template configuration file named "Doxyfile". - Then, I think, I need to modify the Doxyfile to indicate that the source code is not in the current directory.

By the way, will the output be automatically (by default) saved in the directory in which Doxygen is executed?

score 48 · Accepted Answer · answered Mar 18 '13 at 08:33

48

I found the answer already. The procedure is as follows:

Execute doxygen -g. Doxyfile will be generated.
Open Doxyfile and find INPUT =
After the 'INPUT =' put the name of the directory where the source code is located.
Execute in the command line doxygen Doxyfile.
The output will be put into the directory where doxygen was executed.

answered Mar 18 '13 at 08:33

Roman

124,451
167
349
456

1

My folder has 100s of subfolders because of which it fails to generate documentation.It works if I give individual projects do i need to do so manually or it has something to add root folder. – sam Dec 06 '18 at 14:15

score 3 · Answer 2 · answered Nov 05 '21 at 15:23

Besides the INPUT = <src folder> I'd also recommend changing the following in the config file:

RECURSIVE = YES

as discussed in this topic: Doxygen does not find files when specifying Source directory

This will find sources in subfolders of the specified input folder, which was the problem for me.

How to set an input directory for Doxygen?

2 Answers2

Linked