Doxygen: Create project design doc in few clicks

I found doxygen a very effective and easy tool to create a design docs for my projects rather than making it by myself.


All that we have to do is select our projects root folder and "Run Doxygen". It can create output html format at an output folder we choose.

Simply run the index.html to see the whole design doc.

But it is important that we comment in a particular way so that doxygen can identify it and add them in design doc.


See the example below:

- (returntype *)myMethod
{
    /**     * Comment goes here     */
return nil;   }

or use this format:

 /** * Comment goes here */
- (returntype *)myMethod
{
    return nil; }

Doxygen will identify both.

You can get doxygen here.