FlxSound pitch is missing

HaxeFlixel / flixel-docs

Documentation for HaxeFlixel

72 stars 135 forks source link

FlxSound pitch is missing #264

Open T1mL3arn opened 1 year ago

T1mL3arn commented 1 year ago

go to https://api.haxeflixel.com/flixel/system/FlxSound.html
try to find pitch
see no results

Pitch prop was added with https://github.com/HaxeFlixel/flixel/pull/2564 .

Geokureli commented 1 year ago

I believe there's a specific compiler flag we should use to expose fields to the api page, I forgot what it is so we'll have to find it

T1mL3arn commented 1 year ago

The flag is FLX_PITCH and it is set by flixel on targets except flash. But the doc is built for flash target, so the pitch property is not generated.

Possible solutions:

build doc for non flash target, e.g. neko
wrap pitch prop in #if doc_gen

ninjamuffin99 commented 7 months ago

after some investigation this sorta thing seems to affect other "non-flash target" related defines FlxG.android, FlxG.accelerometer. Neither have documentation generated!