Game Development Community

All this Open Source stuff got me thinking . . .

by Jarrod Roberson · in Torque Game Engine · 03/17/2003 (1:05 pm) · 3 replies

With the community growing and more and more new names showing up as "SDK Licensee" why not apply the Open Source mentality to the documentation.

I did enough whining about it when I got my license in May, 2002, I have been doing "internal" documenation as I have been working with the source. I have decided to stop waiting and hire someone to dig thru the more critical sections of code and help me document it and understand it better where I lack in math skills mostly :) And more importantly clean up all the cruft left over from Tribes2 :(

There is what seems like ALOT of dead code, or maybe zombie code that is never used, but could be re-awakened it seems.
Telling the dead code from the zombie code is like trying to tell the sex of an crocodile by just looking! Just looking will do you know good, you have to risk life and limb and get really stinky to find out the truth :)

I think Rick is right, the entire C++ source code base could be documented by the license holders if everyone just picked one or two source code files and started making notes in the source and submitting patches back to Rick!

There just needs to be some way to track who wants to do what so that there is no duplicate effort.

#1
03/17/2003 (1:59 pm)
I agree with this. If there were some way to identify what needs to be documented, have a sign up list for each file/class, and track completion, I would be ecstatic to help. I just don't have time to duplicate something that someone else may be doing.
#2
03/17/2003 (2:06 pm)
That is easy, EVERYTHING needs documenting . . . I will look at configuring a project managment site to manage this so people can sign up if they want . . .
#3
03/17/2003 (3:39 pm)
Just email me what you want to work on and I will keep track so that there is no duplicated effort.

--Rick