CODEWITHSUNDEEP
c++inputdocumentationdoxygen
Roman
Roman

Reputation: 131228

How to set an input directory for Doxygen?

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?

Upvotes: 34

Views: 42307

Answers (2)

AnyGuy
AnyGuy

Reputation: 91

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.

Upvotes: 3

Roman
Roman

Reputation: 131228

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

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

Upvotes: 52

Related Questions