search

FlixelCommunity / flixel

Community fork of Adam “Atomic” Saltsman's popular game engine Flixel. Distilled from a variety of Flash games he worked on over the last couple years, including Gravity Hook, Fathom and Canabalt, its primary function is to provide some useful base classes that you can extend to make your own game objects.
http://flixelcommunity.org/
Other
84 stars 17 forks source link

FlxRandom has ASDoc validation errors #228

Open greysondn opened 9 years ago

greysondn commented 9 years ago

Remember that my current project is built against commit 7232E06F. Being said, a check into file history of FlxRandom shows that the current dev version of the file and the file as of that commit are one and the same.

Text for param in flixel.util:FlxRandom/color is not valid.
org.xml.sax.SAXParseException;
lineNumber: 3;
columnNumber: 6;
The element type "code" must be terminated by the matching end-tag "</code>".

Text for description in flixel.util:FlxRandom/sign is not valid.
org.xml.sax.SAXParseException;
lineNumber: 15;
columnNumber: 6;
The element type "code" must be terminated by the matching end-tag "</code>".

I have modestly reformatted this for readability.

Picking over the description of the errors yielded me nothing. I'm either blind or simply don't see the mismatched <code> tags.

greysondn commented 9 years ago

Addenda: There is also this error in asdoc's output that's not in the validation log:

Warning: Could not get charToByteConverterClass!

It is reasonable to suspect this specific warning may not be a flixel issue at all, given that it doesn't provide a source file and there's more than just flixel in my code. It's provided here in case it may be useful.

greysondn commented 9 years ago

I've found some of it.

FlxRandom line 243, starting partway through the line:

The alpha value, from <code>0 (transparent) to <code>1 (opaque)

Neither one is closed.

Dovyski commented 9 years ago

Nice! That's a simple fix. I will work on it as soon as I can.