Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

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?

like image 996
Roman Avatar asked Mar 18 '13 08:03

Roman


People also ask

Can I configure doxygen from the command line?

You can run doxygen from the command line as long as you have a configuration file to use. However, it is often more convenient to run the Doxygen Wizard – this is a GUI that helps you create a Doxygen configuration file and then runs Doxygen for you.

How do I upload a file to doxygen?

Just list your custom files in the INPUT macro in your doxyfile. You can choose whatever name you find appropriate. Format is text with Doxygen tags.


1 Answers

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.
like image 74
Roman Avatar answered Sep 21 '22 12:09

Roman