Mandarancio / OpenGOO

A free clone of World Of Goo
mandarancio.github.com/OpenGOO
Other
151 stars 20 forks source link

Documentation #35

Open Mandarancio opened 11 years ago

Mandarancio commented 11 years ago

Intro

We have to spend some time writing the documentation of the code, the code is day after day bigger, and the documentation quality is low (Ohloh review).

Doxygen

A very useful tool we can use is Doxygen that is a tool for generate (html but also qt compressed help) documentation.

fasigno commented 11 years ago

The Dst has its doxygen doc, and I have initialized the opengoo doc. But doxygen produces a huge amount of html files and this is not good cause every doc update hide the code changes report in github.

Where can we put the doc folder? It is also useful if the doc is available on the website.