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

"alias for" only links first type #241

Open
Gama11 opened this issue Apr 10, 2018 · 8 comments
Open

"alias for" only links first type #241

Gama11 opened this issue Apr 10, 2018 · 8 comments

Comments

@Gama11
Copy link
Member

Gama11 commented Apr 10, 2018

From http://vshaxe.github.io/vscode-extern/vscode/MarkedString.html. Maybe it can't find EitherType, but it should at least be able to link-ify String?

@Gama11
Copy link
Member Author

Gama11 commented Apr 10, 2018

Oh, actually the API docs don't include String either due to using --toplevel-package. But I wonder if the types shouldn't still be colored anyway, as it looks a bit odd like this. Here they're colored too, even if not clickable:

@markknol
Copy link
Member

markknol commented Apr 11, 2018

I think the generator should always generate pages for all types, but use -i and -o params only for the menu. That'll solve some similar issues.

@Gama11
Copy link
Member Author

Gama11 commented Apr 11, 2018

I'm not sure about that, it's kinda nice that you can cut down the generation time by specifying a toplevel package.

@markknol
Copy link
Member

Then I would expect it to not highlight types that are excluded, all time. (Or always include all toplevel types maybe?)

@Gama11
Copy link
Member Author

Gama11 commented Apr 11, 2018

Another option might be to link to https://api.haxe.org/ for stuff from the std lib?

@markknol
Copy link
Member

Then we also need to know which Haxe version is used, which we don't know (I think?).

@jgranick
Copy link
Contributor

I also think that linking to api.haxe.org for core types would be great. I would recommend using the stock URLs (https://api.haxe.org/js/Cookie.html, etc), which will link to whatever version is default there.

Later, perhaps a configuration option could be used to set an exact version of Haxe, but I (for one) would prefer not to link our documentation to a specific Haxe release. Users are going to use a mixture of versions anyway. Otherwise if preferred, there should be a way to use haxe_ver to detect the current version (haxe.macro.Compiler.getDefine ("haxe_ver")) though I would be happy with unversioned links

@cancerberoSgx
Copy link

cancerberoSgx commented Jul 6, 2019

an ugly one , specially for new people since haxe types has these "creative" names non familiar on POSIX is https://api.haxe.org/haxe/io/BytesData.html , even for core classes like IO and absolutely no description of the type.

Please see #257 for I think should be the standard behavior (never parse statements in macros and let the user be responsible of explicitly declare documentation of them (with annotations or dummy statements outside macros))

I suspect this applies in general not only to typedef / alias of

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants