Game Development Community

Generate c++ and script documentation

by Luis Anton Rebollo · in Torque 3D Professional · 05/08/2014 (3:30 pm) · 14 replies

Generate Documentation:
  • Download this file and extract on Torque 3D directory.
  • Enter Documentation/ directory.
  • Execute generateEngineReference.bat for generate c++ reference.
  • Execute generateScriptManual.bat.bat for generate script reference.

    • Download c++ engine reference
    Download script reference

    I think we should to upload these files to github.
  • In the T3D repository?
  • In documentation repository?
  • On wiki?

    • I'd rather be the source code and this type of documentation. together.
    NextNext Thread
    PrevPrevious Thread
    More from Torque 3D Professional


    Torque Owner Nathan Martin
    TRON 2001 Network
    #1
    05/08/2014 (4:04 pm)
    Belongs in the Documentation repository, that's why it exists in the first place.

    Torque Owner Daniel Buckmaster
    T3D Steering Committee
    #2
    05/08/2014 (4:30 pm)
    I agree.

    Andrew Mac
    #3
    05/08/2014 (8:36 pm)
    First link appears to be dead. Agreed it should go in documentation.

    Torque Owner Nils Eikelenboom
    Studio DimSum
    #4
    08/03/2014 (5:35 am)
    Can't open the pages in both compiled .chm files

    Windows 7 / 64 / SP1

    Torque Owner Nils Eikelenboom
    Studio DimSum
    #5
    08/03/2014 (5:38 am)
    Sorry, I was too quick; files were blocked because I've downloaded them from the internet. Unblocked these in the properties panel (right click) and the pages can now be opened.

    Thanks @Luis!

    Torque Owner Richard Ranft
    Roostertail Games
    #6
    08/03/2014 (9:52 am)
    Yes, it belongs in the repo - but that means it must always be up to date. Active maintenance means more work for someone....

    Unless you guys can set up a nightly build that runs through this process and pushes the changes live to the wiki somehow....

    Torque Owner Anders Dahnielson
    #7
    08/03/2014 (1:53 pm)
    Although, there are some problems with the output to generate the documentation from as I outlined here, that I haven't looked into yet to try to fix:

    http://garagegames.com/community/forums/viewthread/138419


    Torque Owner Daniel Buckmaster
    T3D Steering Committee
    #8
    08/03/2014 (4:22 pm)
    Is this sufficient? I wonder if we could use that same job to generate the script docs as HTML as well...

    Torque 3D Owner Luis Anton Rebollo
    #9
    08/04/2014 (1:55 am)
    Good idea. Added to my TODO creation of CHM files on CI server.

    gdyxml2000
    #10
    08/04/2014 (6:23 am)
    very usefull !

    Torque Owner Daniel Buckmaster
    T3D Steering Committee
    #11
    08/04/2014 (2:05 pm)
    Luis - could we make use of Github tickets for todo lists? Like I've done here, and I've added a list to your CI ticket.

    Torque 3D Owner Luis Anton Rebollo
    #12
    08/04/2014 (4:36 pm)
    You're right, it makes more sense to use Github :P

    Thx.

    Torque Owner Daniel Buckmaster
    T3D Steering Committee
    #13
    08/04/2014 (4:55 pm)
    For public projects, at least, it provides some nice feedback for anyone who's watching our progress.

    Torque 3D Owner Luis Anton Rebollo
    #14
    08/24/2014 (4:23 pm)
    Not finished:

  • t3dci.org/job/T3D-dev-common/Script_Reference/
  • t3dci.org/job/T3D-dev-common/Engine_Reference/