Game Development Community

SandCastle Documentation

by David Everhart · in Torque X 2D · 08/01/2008 (12:00 am) · 6 replies

Hi all,

I used sandcastle (microsofts new document generator) to generate a compiled help module (chm) of the TX 2.0 api, so I can go through and read all the comments. Anyone know the restrictions on putting it up here for others or what not?
NextNext Thread
PrevPrevious Thread
More from Torque X 2D


Associate John Kanalakis
EnvyGames
#1
08/01/2008 (9:05 am)
I haven't used sandcastle, does the chm include the source code, or just class/method/data names? I'm pretty sure that it's fine to post as long as there is no source code displayed within .chm. I've always used Doxygen to create API docs, so I would really like to see the difference.

John K.

Torque Owner David Everhart
#2
08/01/2008 (11:08 am)
There is no source code , its just the methods and comments. I checked out doxygen, and ndoc 2.0 support, but the sandcastle stuff seems to work . Ill find a hosting place and see if I can put it out somewhere.

Torque Owner David Everhart
#3
08/02/2008 (4:38 pm)
Ok, Here is the .chm it created. I think this only has 30 days up due it being a free account. Id be interested to hear your comparison between doxygen and sandcastle. The chm by sandcastle is not to bad, it uses a gui, but I know it could use some clean up.

Clicky

Torque Owner Eyal Erez
#4
08/05/2008 (8:19 am)
Thanks a lot David.
This really helps a lot.
I've been trying to port my TGB game to TX and find it quite a challange.
I was about to give up like many others, but this may keep me going for a few more days :)

Employee Michael Perry
ZombieShortbus
#5
08/05/2008 (9:22 am)
Interesting post David. I'll need to look into this further.

Associate John Kanalakis
EnvyGames
#6
08/05/2008 (2:45 pm)
Very nice! Now I'm torn... I still like some of the formatting in Doxygen better, but I also Sandcastle's ability to filter the view, for example: Show me only the public methods in this class. It definitely offers a much faster way to drill down into the Framework. I'll have to look at this more closely ;) Good find, David !!!

John K.