Basically you just need to comment the functions and classes with the appropriate comment blocks and it generates a wiki with call graphs and cross references and everything.
Quoting a post I made previously about this:
Quote:
Originally Posted by IntoRain
Can I suggest doxygen-style comments for the classes and functions? Doxygen automatically generates a wiki thing (.html) with information on all classes and functions from just comments, making it easier in my opinion for us to search for stuff. I know it kinda sucks to comment everything, but since you will be changing the code a lot and since some of the older functions and core classes are already commented, I thought I'd suggest doxygen-style comments: http://www.doxygen.nl/docblocks.html
The generated .html pages look awesome:
http://i.imgur.com/xwg2V9c.png (example of a function description (detailed) - it has the call graph and the caller graph!)
http://i.imgur.com/O8nIDdC.png (example of a class list, it shows undetailed member functions with the details at the end of the page - it has a search function! it also shows class hierarchy, files, etc!) |
(please ignore the fact I used both C-style and Java-style code standards for the function names lol it's messy I know)
You can customize the wiki colors and structure as well, I just didn't lose much time with it.
I say yes to creating a wiki for user guides like Kyttias' though.