Game Development Community

dumpFunctions error

by Nathan Bowhay - ESAL · in Torque 3D Professional · 06/30/2010 (2:20 pm) · 3 replies

Seems like doxygen comments with parentheses are causing error in the parsing. What will happen is I have something like this:
///Truncate %val to the %n decimal place (ex. Round(5.67932,2) is 5.67)
function Truncate(%val, %n){
}

and the generated file will have something like this:
/*!  is 5.67)
 */
   virtual Script Truncate(ex. Round(5.67932,2) {}

Then when I generate the html files a not just this one will sometimes not show up, but many others as well (anything below that in scriptFunctions.txt)

I am currently using 1.1 Alpha, but from looking at the code doesn't look like beta 1 changed much of this so I am guessing it is an issue there as well.
NextNext Thread
PrevPrevious Thread
More from Torque 3D Professional


Torque Owner Tobias B.
mercatronics
#1
06/30/2010 (2:48 pm)
Good question Nathan, I produced my documentation with 1.0.1. I walked through it, but haven´t found iusses like you. Did you test 1.0.1 as well?

Torque 3D Owner Nathan Bowhay - ESAL
ESALPllc
#2
06/30/2010 (3:11 pm)
No I didn't. If I get some time I will test it out on those builds. You should just be able to add those comments above some function and it will cause it, if you wanted to test. I am sure numerous other things with parentheses will cause it as well. Although I do have some with parentheses that work fine after looking harder.

Torque 3D Owner Nathan Bowhay - ESAL
ESALPllc
#3
06/30/2010 (5:18 pm)
Looks like:
///(%x, %y, %z, %isOk = true)

is an exception and it actually handles it nicely.

I you had:
///(%x, %y, %z, %isOk = true)
function foo(%x, %y, %z, %isOk)
{
}

The generated file would have:
virtual Script foo(%x, %y, %z, %in = false) {}

which is really nice to know. It is just other cases that cause it.