We're a bunch of Outcast fans who are also interested in game development. When Outcast 2 was canceled some years ago because Appeal went bankrupt there was only one solution: Create our own inofficial sequel!
Most Game SDKs that include C++ code don't have a proper documentation of the API. Learn how to generate such a documentation automatically using only the source files.
Posted by s87 on Feb 15th, 2010
Basic Client Side Coding.
Virtually any Game SDK comes nowadays with a bunch of source files which are used to generate some kind of custom DLL for your mod.
Mostly though the classes and functions aren't documented properly outside of the source code and using the search function of your IDE to get an overview of interfaces and classes can be pretty fatiguing.
Even if the functions are not documented you could at least see members of classes and parameters of functions listed properly and linked among each other.
This is exactly what a tool called Doxygen is capable of.
By following some rules for commenting your code Doxygen can generate descriptions of classes, function parameters and much more. Many open Source projects use it to generate their documentation.
Though most sourcefiles from SDKs aren't optimized for the use with Doxygen you will still always be able to get all classes and functions listed clearly.
Get the Doxgen-Setup from Stack.nl
After installing start Doxywizard - a graphical frontend for Doxygen.
Specify the working directory (should be *Programs*/doxygen/bin)
Settings for the Project topic:
Note: The parent folder of Destination Directory has to exist else the program will fail.
Settings for the Mode topic:
Settings for the Output topic:
Go to the Run Tab and press Run Doxygen
Check out Destination Directory\html\index.html
Now you should have a HTML documentation of the API of your favourite SDK.