How to set an input directory for Doxygen?

c++ input documentation doxygen
Roman picture Roman · Mar 18, 2013 · Viewed 25.5k times · Source

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?

Answer

Roman picture Roman · Mar 18, 2013

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.

Related questions

How to read until EOF from cin in C++

I am coding a program that reads data directly from user input and was wondering how could I (without loops) read all data until EOF from standard input. I was considering using cin.get( input, '\0' ) but '\0' …

Read More
Why would we call cin.clear() and cin.ignore() after reading input?

Google Code University's C++ tutorial used to have this code: // Description: Illustrate the use of cin to get input // and how to recover from errors. #include <iostream> using namespace std; int main() { int input_var = 0; // Enter the do …

Read More
Multiple inputs on one line

I have looked to no avail, and I'm afraid that it might be such a simple question that nobody dares ask it. Can one input multiple things from standard input in one line? I mean this: float a, b; char …

Read More