flixel-docs icon indicating copy to clipboard operation
flixel-docs copied to clipboard

Published 20 hours ago • verified publisher icon HaxeFlixel

AssetPaths documentation

Open T1mL3arn opened this issue 2 years ago • 3 comments

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.

  • How to add api docs? Edit a template file ?
  • Then how to add such changes to api.haxeflixel.com ?

T1mL3arn avatar Feb 20 '23 11:02 T1mL3arn

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

Geokureli avatar Feb 20 '23 14:02 Geokureli

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.

T1mL3arn avatar Feb 21 '23 10:02 T1mL3arn

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

Geokureli avatar Feb 21 '23 17:02 Geokureli