I’ve been working on learning Haxe and OpenFL for personal/hobby games, and I’ve had trouble browsing the documentation as a usage guide. Several function and field descriptions seem mismatched on the API website. Perhaps this mismatch is due to commented-out code in the source?
For example, in
openfl.text.TextField, the variable
antiAliasType has the description:
When set to
trueand the text field is not in focus, Flash Player highlights the selection in the text field in gray. When set to
falseand the text field is not in focus, Flash Player does not highlight the selection in the text field.
The link to that page is here.
In the source code on my machine (which
haxelib reports to be OpenFL 9.0.2), the following snippet can be found:
/** When set to `true` and the text field is not in focus, Flash Player highlights the selection in the text field in gray. When set to `false` and the text field is not in focus, Flash Player does not highlight the selection in the text field. @default false **/ // var alwaysShowSelection : Bool; /** The type of anti-aliasing used for this text field. Use `openfl.text.AntiAliasType` constants for this property. You can control this setting only if the font is embedded(with the `embedFonts` property set to `true`). The default setting is `openfl.text.AntiAliasType.NORMAL`. To set values for this property, use the following string values: **/ public var antiAliasType(get, set):AntiAliasType;
From this point of view, the
alwaysShowSelection variable seems to be the culprit of the mismatch. However, I’m also concerned by the fact that I can’t seem to find this same snippet of code on GitHub, even when browsing under the 9.0.2 tag. On Github, the
alwaysShowSelection variable seems to have been removed entirely.
So my primary two questions are:
- How can I get the documentation in my local code editor to reflect the proper description? (I use Visual Studio Code, though I think my question applies to all local editors.)
- When will the published online documentation be updated to reflect these changes?
Tangentially, I am also curious:
- Why is the source code on my machine different than what is tagged on GitHub? The file path to
Thank you for your help.