View Full Version: Improve Documentation

CloneKeenPlus > Discussion > Improve Documentation


Title: Improve Documentation
Description: Bad Documented Code


gerstrong - March 6, 2010 06:57 AM (GMT)
Hello guys,

I'm sensing that the motivation on coding out project has been missing a bit lately. I really can understand it.

I want to help you a bit. I want to integrate Doxygen.

What is that you may ask:

Doxygen Link

For those who know Javadoc, let me tell you that doxygen is the same for C/C++ Projects, although it can be used for many other projects.

Putting the right comments into the code will generate a documentation of itself. Now I want to open a section where you can see them and with a brief explanation about what does every function and its parameters. I hope this way, the code will better be understood.

You will be able to open a HTML file on the web-browser like a help guide which will tell you what every function does and what it will do. It is automatically updated whenever we update our sources. I hope I get it that way done...

Of course, we will be forced to comment more the code, but I think it is better that way to have good quality in future and not have misunderstandings.

pizza2004 - March 6, 2010 03:14 PM (GMT)
Sounds good to me.



Hosted for free by InvisionFree