Duplicated Note in engine overview
by Gregory "Centove" McLean · in Torque Game Engine · 05/01/2004 (6:02 am) · 3 replies
While browsing through the documentation I thought I was seeing double there for a bit..
In engine.overview.txt:
There is this:
---
@note This documentation is aimed towards C++ developers. If you're looking for information on how to use the engine's support tools, or work with the scripting language or editors, you may have better luck looking at http://www.garagegames.com/docs/torque.sdk/index.php.
@subsection Intro_ProgSkills What Do I Need To Know?
It would be great if it were possible to buy Torque and without any prior knowledge start making incredible, technologically ground-breaking games... but sadly, that's not possible. Writing game engines is an advanced skill. Luckily, Torque is already written. All you need to do is start building off of its foundation.
@note This documentation is aimed towards C++ developers. If you're looking for information on how to use the engine's support tools, or work with the scripting language or editors, you may have better luck looking at http://www.garagegames.com/docs/torque.sdk/index.php.
---
http://www.garagegames.com/docs/torque.sdk/engine/index.php
Shows the result of this..
Kinda unneccessary IMHO.. one of em should go.
(or make it
In engine.overview.txt:
There is this:
---
@note This documentation is aimed towards C++ developers. If you're looking for information on how to use the engine's support tools, or work with the scripting language or editors, you may have better luck looking at http://www.garagegames.com/docs/torque.sdk/index.php.
@subsection Intro_ProgSkills What Do I Need To Know?
It would be great if it were possible to buy Torque and without any prior knowledge start making incredible, technologically ground-breaking games... but sadly, that's not possible. Writing game engines is an advanced skill. Luckily, Torque is already written. All you need to do is start building off of its foundation.
@note This documentation is aimed towards C++ developers. If you're looking for information on how to use the engine's support tools, or work with the scripting language or editors, you may have better luck looking at http://www.garagegames.com/docs/torque.sdk/index.php.
---
http://www.garagegames.com/docs/torque.sdk/engine/index.php
Shows the result of this..
Kinda unneccessary IMHO.. one of em should go.
(or make it
#2
It is a pretty fundamental note, helping people decide whether the document is worthwhile to them or not. Since there's no guarantee that everbody is going to read the entire document, having the note in there a couple times is probably good. Of course, I wouldn't want it in every other paragraph, but twice is ok, imo.
Thank you for the feedback though, documentation suggestions are always welcome.
edit: ahh.. Ben's ninja-fingers best me yet again.
05/01/2004 (12:05 pm)
Thanks for pointing this out. I don't think it's necessarily bad thing though. It is a pretty fundamental note, helping people decide whether the document is worthwhile to them or not. Since there's no guarantee that everbody is going to read the entire document, having the note in there a couple times is probably good. Of course, I wouldn't want it in every other paragraph, but twice is ok, imo.
Thank you for the feedback though, documentation suggestions are always welcome.
edit: ahh.. Ben's ninja-fingers best me yet again.
#3
05/06/2004 (7:48 am)
Quote:*smack* I keep forgetting that!
You never underestimate the foolishness of some people... ;)
Associate Kyle Carter
So far I think it's worked pretty well.