search

HaxeFlixel / flixel-docs

Documentation for HaxeFlixel
72 stars 135 forks source link

AssetPaths documentation #265

Open T1mL3arn opened 1 year ago

T1mL3arn commented 1 year ago

I read some quirks about it (like https://github.com/HaxeFlixel/flixel/pull/2575). Also got some struggle with it by myself - asset file names started with a digit is not shown on AssepPaths. Would be nice to have proper documentation, either as API docs or a page in handbook.

Geokureli commented 1 year ago

api pages are generated from the documentation in the haxe classes, since AssetPaths is generated from a template it's not in the api

Maybe we could add doc comments to AssetPaths in the template https://github.com/HaxeFlixel/flixel-templates/blob/dev/default/source/AssetPaths.hx

T1mL3arn commented 1 year ago

Will it be possible to setup docgen to actually include AssetPaths? I believe reading its doc from rendered html page is far more better than from ide.

Geokureli commented 1 year ago

I wouldn't know how to do it, also I like having more documentation on the template files, personally. we should try to get the macro classes in docgen, tho. I'm not sure why FlxAssetPaths.hx isn't there