Better Engine Documentation

#1

Quote:I think there should be somewhere where members can add an engine function reference for some of the more useful functions.

There is such a place, TDN. You may have already seen it and used it a few times, but if not, this is the best place for users to add engine documentation for others to see and learn from. It's a wiki-based system, so it takes some getting used to. All that's needed are some dedicated folks to add documentation as they go. However, as such a collection of engine documentation grows, keeping everything organized might present a challenge.

#2 I agree with Richards H. Torque c++ code lacks of documentation. I'd like to have TGE documentation like TGB docs.

#3 Before this post turns into another "TGE needs more docs" discussion, take a search on the forums. There are tons of posts that start off just like this that have a lengthy discussion on this topic.

- Eric

#4 Is there a desription of how to add to TDN?
I have used it several times, that's where I found the best script documentation.

Edit: Never mind, I found the TDN Meta button.

#5

Quote:There is such a place, TDN. You may have already seen it and used it a few times, but if not, this is the best place for users to add engine documentation for others to see and learn from.

I believe what the documentation of the engine is responsability of the creators and NOT of the Users!!!

#6 There is documentation provided by the Torque creators. There is also documentation provided by users, as found on TDN and in the forums.

And you know what, I'm sick of this. I think a major point is being overlooked. By purchasing the engine, you become a member of a community. This, by far, is better than any online or hard-copy document. If you want to know about the functionality of the engine class GuiCanvas, you WILL find it here on GarageGames.com and on the TDN.

If you want help with understanding or modifying this class, you, as a community member have the option to post in the private forums and get help from seasoned Torque developers. Not to mention, employees and the engine authors get involved to clarify particularly difficult questions and scenarios.

Eric Roberts is correct, this has been an ongoing topic for years. When I first started using Torque back in 2003, it was for my final project at Full Sail as a college student. One other team was using Torque as well.

When we presented our Alpha versions, we had to get up in front of the class to talk about what we've accomplished and what our obstacles have been. They said they couldn't find any documentation, we said we found plenty of documentation. I'm sure this discussion even pre-dates my example.

I have been a member of different communities and organizations, game-dev related and not. This, by far, is the best I've ever been a part of. You can call me a Torque/GG fanboy if you want, but I'm now a professional game developer by day and an Indie game-dev by night. If there wasn't enough engine documentation and community support, I wouldn't be using Torque at my job and at home.

*END RANT*

#7 Yes... I Know!!!

The only thing that I wanted to say is that a thing not cover the another one. ONLY!!!