Function Tooltip Hang with Torsion Work Around
by David Cobb · in Torsion · 06/19/2007 (2:36 am) · 1 replies
mantis.sickheadgames.com/view.php?id=581
Basically a comment block that starts with /**, has a line longer than 80 characters, and preceeds a function definition will cause a hang when Torsion tries to display the function tooltip. The tooltip displays both when you are initially defining the function and when you are typing out a call to the function.
I ran into this because I am accustomed to filling the first full line of my function header comments with asterisks to set it off from the rest of the code. There is a hidden complication with this as well because two neighboring comment blocks (with no code between them) will have their adjacent lines concatenated in the tooltip which may push it over the 80 character limit.
The quick workaround for me was to simply modify the first line of the comment blocks to be /* ******etc. As long as the comment block doesn't start with exactly /**, it is ignored.
This is just a heads up for people that don't check the bug tracker. Figured since I burned all my coding time tonight testing this bug, I might as well share so someone else doesn't get bit by this.
Basically a comment block that starts with /**, has a line longer than 80 characters, and preceeds a function definition will cause a hang when Torsion tries to display the function tooltip. The tooltip displays both when you are initially defining the function and when you are typing out a call to the function.
I ran into this because I am accustomed to filling the first full line of my function header comments with asterisks to set it off from the rest of the code. There is a hidden complication with this as well because two neighboring comment blocks (with no code between them) will have their adjacent lines concatenated in the tooltip which may push it over the 80 character limit.
The quick workaround for me was to simply modify the first line of the comment blocks to be /* ******etc. As long as the comment block doesn't start with exactly /**, it is ignored.
This is just a heads up for people that don't check the bug tracker. Figured since I burned all my coding time tonight testing this bug, I might as well share so someone else doesn't get bit by this.
Associate Tom Spilman
Sickhead Games