Game Development Community

Difference in documentation

by Michael Hartlef · in Torque Game Builder · 01/14/2008 (1:56 am) · 3 replies

Hi all,

does someone know the difference and why there seems to be one between the documentation that ships with TGB and the one from the TDN?

http://tdn.garagegames.com/wiki/TGB/Reference

The TDN one is much more detailed when it comes to describing a function.

#1
01/14/2008 (7:19 am)
Perhaps because the documentation is for different versions of the product or users have been adding additional information. I'm not sure how the documentation is generated for TGB, but I do not think it is converted from the wiki doco.
#2
01/14/2008 (7:34 am)
The wiki / TDN is community driven. So we the users put up alot of the content on it. (Not saying GG doesnt do there share) Just that its alot more detailed because generaly when you have a programmer or someone that uses the product day in / day out you tend to get some detailed how-to's from them. Also since its community driven theres alot more people putting information and adding to it.
#3
01/25/2008 (6:38 pm)
The TGB reference on TDN was (at one point) the same version packaged with TGB. This was originally put up and maintained by us and since has had some minor fixes and updates done by our great community.

We recently switched from a manually maintained reference to a completely auto-generated reference based off of source code descriptions (with examples parsed in externally). The downside is we need to port the existing TGB reference documentation into the engine and format it appropriately, the upside is every single script accessible function is dumped in the reference. Unfortunately we haven't gotten the source code documentation updated, though in the future this would be a great addition since the old reference does hold some very useful information.