Game Development Community

Basic Documentation

by John Kanalakis · in Torque X 3D · 11/06/2006 (11:32 pm) · 6 replies

Given that we don't have access to the engine source code, would it be possible to get an API dump in some sort of document? Something like the DOxygen output would be great. Of course, I don't expect any comments or descriptions, but a complete list of public/private methods & variables in a .pdf file can really help. This way we can start with an overview of all the TorqueX namespaces & functionality and then pick a path to dive into instead of straining eyes with the Intellisense help.
John Kanalakis's profile picture
Associate John Kanalakis
EnvyGames

About the author

John Kanalakis is the owner of EnvyGames, an independent game development studio in Silicon Valley that produces games and tools for Xbox 360, Windows, and the Web.

Recent Threads

  • Torque 3D 1.2 Release
  • 2D Artist Needed - Paid Contract
  • Is Resolving a RenderTarget to a GBitmap possible?
  • Screenshot broken in MacOS build? - LOGGED
  • Torque X Platformer Kit 3.1.0.1 Released
    • NextNext Thread
    PrevPrevious Thread
    More from Torque X 3D


    Torque 3D Owner Florian Ross
    #1
    11/07/2006 (3:47 am)
    You can get an overview over all classes using VC#'s Class View.
    In C# you cant have code outside of classes so you wont miss anything this way

    Torque Owner Pauliver
    #2
    11/07/2006 (6:49 am)
    Http://www.aisto.com/roeder/DotNet/

    dot net reflector will allow you to get a much better idea of the methods and workings of the code. (its on the microsoft top 10 tools for dev's list)

    Associate John Kanalakis
    EnvyGames
    #3
    11/07/2006 (9:09 am)
    I'm very familiar with both tools, but neither can output to a concise & readable document for faster reference. Creating DOxygen output should only take a couple of minutes and prove to be extremely useful.

    Torque 3D Owner Jonathon Stevens
    #4
    11/07/2006 (9:11 am)
    I second the motion for Doxygen docs!

    Torque Owner Voldemos
    #5
    11/07/2006 (1:47 pm)
    Try this:

    http://www.kynosarges.de/NDoc.html

    Free and generates nice, searchable compiled help files...

    Associate David Higgins
    DPHCoders.com
    #6
    11/07/2006 (9:17 pm)
    I would go with Vol's suggestion and use NDoc, it generates nice MSDN-Like documentation in both CHM (Compiled HTML Help) and Single and Multi Page HTML files -- it does a complete reflection against the assemblies, and includes any XML formatted code comments as well.