Documentation generation

Documentation of code is very important for any project. It builds an overview of the written code, explains its usage, and helps developers understand the code. Code::Blocks allows generation of code documentation from the IDE itself.

Doxygen is a standard tool to create documentation from annotated C++ files. Code::Blocks comes with a plugin called DoxyBlocks that creates an interface with the externally installed doxygen tool.

We need to download and install doxygen tool first. Subsequently we can use DoxyBlocks plugin to generate documentation. Perform the following steps:

1. Download doxygen from the following URL—http://www.stack.nl/~dimitri/doxygen/download.html. Also download doxygen-x.x.x-setup.exe file. Double-click on that file to install it.

2. We need to connect DoxyBlocks plugin with doxygen tool. Go to DoxyBlocks | Open preferences… menu option. The following screenshot will be displayed:

   

3. Click on the General tab. Next click on the Browse button next to Path...