Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AssetPaths documentation #265

Open
T1mL3arn opened this issue Feb 20, 2023 · 3 comments
Open

AssetPaths documentation #265

T1mL3arn opened this issue Feb 20, 2023 · 3 comments

Comments

@T1mL3arn
Copy link
Contributor

I read some quirks about it (like HaxeFlixel/flixel#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 ?
@Geokureli
Copy link
Member

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 added a commit to T1mL3arn/flixel-templates that referenced this issue Feb 21, 2023
@T1mL3arn
Copy link
Contributor Author

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
Copy link
Member

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 added a commit to HaxeFlixel/flixel-templates that referenced this issue Mar 6, 2023
* Documentation for AssetPaths

To address this HaxeFlixel/flixel-docs#265

* Address review issues

* address review issues

remove "more control" (will be in other doc)
add @see tags

* a note about where is this class from

* add left *

* aork around vscode md issues, shorten

---------

Co-authored-by: George FunBook <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants