Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Specify Doxygen parameters through command line

Tags:

bash

doxygen

Well I am creating a script to automatically generate documentation for my projects with Doxygen, which seems like an awesome tool.
What is not clear to me, is if the user can use specify directly parameters, such as project name, project description etc., by setting them besides command:

doxygen -g "parameter modification here" doxygen Doxyfile 

Any tips appreciated!

like image 330
Potney Switters Avatar asked Jun 14 '12 11:06

Potney Switters


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.

What does @{ mean in doxygen?

Doxygen will put members into the group whose definition has the highest "priority": e.g. An explicit \ingroup overrides an implicit grouping definition via @{ @} . Conflicting grouping definitions with the same priority trigger a warning, unless one definition was for a member without any explicit documentation.


1 Answers

Look at the answer for question 17 in the FAQ: http://www.doxygen.nl/manual/faq.html#faq_cmdline, repeated below for convenience:

Can I configure doxygen from the command line?

Not via command line options, but doxygen can read from stdin, so you can pipe things through it. Here's an example how to override an option in a configuration file from the command line (assuming a UNIX environment):

( cat Doxyfile ; echo "PROJECT_NUMBER=1.0" ) | doxygen - 

For Windows the following would do the same:

( type Doxyfile & echo PROJECT_NUMBER=1.0 ) | doxygen.exe - 

If multiple options with the same name are specified then doxygen will use the last one. To append to an existing option you can use the += operator.

like image 68
doxygen Avatar answered Sep 28 '22 11:09

doxygen