Generate HTML documentation using doxygen for C#

This post is dedicated to developers because after reading this post developers life will easy to create the document directly from the code.

For creating the document, we are going to cover the Doxygen utility.

Using Doxygen, a developer can create the document using Doxygen GUI or Doxygen command. We are going to cover both ways generate the document. The first post we are cover GUI only and next post will cover Doxygen command.

Before we going further one thing is very important to generate document is the comment of the code without comment document will not generate properly.

I assume you know, how to write XML comment on the code of every method, classes, and other objects.

Once you have written comments on code and ready to generate the document.

For generate the document follow the below steps.

Step 1: Download Doxygen from the Doxygen website.

Step 2: Once download, install into your system.

Step 3: After installation, open the Doxywizard

Step 4: Once open Doxywizard GUI then follow below image with steps.

In Doxygen GUI, check the yellow highlighted text with the following explanation. 

Above image step 1: Specify the working directory from which doxygen will run. For that, you need to create a blank folder and select that path. In our demo, we have created DOXY folder under the D drive.

Above image step 2: Select the Wizard tab and select Project from Topics. Right-hand side fills form details as per your project related to Project Name, Source code Directory Path, Destination Directory and Scan recursively.

For Scan recursively checkbox use for the subfolder scanning.

Now click on Mode Topics and select your project language, We have selected "Optimise for Java or C# output"

Step 5: Once done with Wizard tab click on Expert tab

Under Expert tab select Build Topics and select as per your requirement configuration options from the right-hand side. For the understanding of the configuration options, visit on Doxygen site.

Here we have select few options which are good to generate the document.

Step 6: Last step for the generate document. Click on Run tab

Once you click on Run tab, you will see the Run doxygen button underneath the tab. Now we are ready to generate the document.

Click on Run doxygen button and you will see the progress on the output produced by doxygen box.

After successful completion, you will check your output directory folder and your document will be ready. 

Open the index.html page on the browser and check document.

Hope you like it. Happy Codding!!