Using Doxygen command line to Generate HTML documentation for C# Application

We have covered document generate using Doxygen GUI in the previous post. As I have mentioned in the previous post to cover Doxygen command in next post.

So As we are going to cover Doxygen command using generate documentation. 

I assumed you have already downloaded and installed Doxygen in your system.

And your C# application very well commented on method, classes, and other objects.

So, after all, set we are going to generate a document using the command line.

Step 1: Press CTL+R and write cmd and hit the enter to open the command prompt.

Step 2: First a fall need to create Doxygen configuration file using command line with the following command

C:\Work>doxygen -g doxygenfile

Run above command and generate the configuration file.

Step 3: Once the configuration file is generated require few configuration as per your project and path requirements. So edit generated configuration file and update following options.

INCLUDE = Doxygen config_file_name
OUTPUT_DIRECTORY = Doxyment_directory
PROJECT_NAME = "My Project"
RECURSIVE = YES
OPTIMIZE_OUTPUT_JAVA = YES

Above configurations are good to generate the document. For more configurations visit on Doxygen website.

Step 4: Once you done with configuration file changes then run command for the document generate.

doxygen <config_file>

Above is the syntax for doxygen command.
Run the below command to generate the document.

doxygen doxygen

Once you run above command. Doxygen will process the generate document.

Step 5: Once above command successfully run then you will check your output directory and the document will be there.

You can get the source code from github.

That's it!! 

Hope you like it. Happy coding!.