 |
|
 |
|
|
|
Please take note! For mod developers working with Unreal Tournament 2003, this documentation is meant to be a starting point for your own explorations into UT2003, not a definitive guide. There will be differences between the documentation here and the product in your hands, and you may have to figure out quite a bit for yourself. Check out the Unreal Tournament 2003 page in the Unreal Powered area for links to community sites if you're having problems. UDN is a licensee support site, and cannot provide technical support or game-specific assistance to end users.
|
|
|
|
|
 |
UnDox |
 |
|
|
|
|
|
Licensees can log in
.
Interested in the Unreal engine? Check out the licensing page.
Questions about UDN itself? Contact the UDN Staff.
|
|
|
|
|
|
|
|
|
|
Last updated by Richard 'vajuras' Osborne (UdnStaff), added more detail about javadoc problem. Original author was Vito Miliano (UdnStaff).
UnDox is a program that transforms UnrealScript? into HTML documentation.
UnDox is a Win32 console program written in C/C++. It is based on modern-day compiler design with several 'twists' to account for some of the intricacies of the UnrealScript? programming language. It is highly optimized for lexical analysis of UnrealScript? and HTML generation.
UnDox <package dir> <output dir> [noshow] [verbose]
[inifile=<filename>] [stylesheet=epic|epic2|sun|<filename>]
[EditPackages=<package name>]+
Where:
- package dir - directory which contains script packages - REQUIRED
- output dir - directory to write documentation to - REQUIRED
- noshow - prevents display of index.html upon completion
- verbose - produce lenghty output messages (mainly for debugging)
- stylesheet - specify stylesheet, default is epic. epic, epic2, and sun are built-in. Supply filename or your own stylesheet to customize
- inifilename= - file which contains EditPackages= lines. Defaults to \System\UnrealTournament.ini
- EditPackages= - one or more package names to search before packages listed in the inifile's EditPackages lines.
UnDox is now owned by EpicGames. So all copyright notices, license agreements and other such things that used to say E. Bruce Shankle III, now say EpicGames.
A bug was fixed whereby parameters of functions were listed in reverse order. Thanks to j c (unprovoked2000@yahoo.com) for pointing this out.
UnDox makes use of style-sheet technology which works well in IE but may not always work in other browsers. If this is a huge problem for you, then delete the stylesheet.css file that gets created when you run UnDox.
Richard 'vajuras' Osborne has informed me that the ucc compiler has some problems with normal java-doc style of commenting if used above the unrealscript class definition. It looks like I'm going to have to provide C-Style comment parsing to work around that.
Attachment:  | Action: | Size: | Date: | Who: | Comment: |
|---|
 Undox-src.zip | action | 392027 | 09 Jan 2002 - 11:43 | UdnStaff | UnDox source and Win32 binaries |
|
|
