docs: note Type API only guaranteed for Haxe-generated types by TrueFurina · Pull Request #13024 · HaxeFoundation/haxe · GitHub
Skip to content

docs: note Type API only guaranteed for Haxe-generated types - #13024

Merged
Simn merged 3 commits into
HaxeFoundation:developmentfrom
TrueFurina:docs/type-api-haxe-generated-only
Oct 27, 2026
Merged

Simn merged 3 commits into
HaxeFoundation:developmentfrom
TrueFurina:docs/type-api-haxe-generated-only

Conversation

@TrueFurina

Copy link
Copy Markdown
Contributor

Summary

Per #6113 (from discussion in #5645): Type.resolveClass() cannot resolve external/native types (e.g. classes declared with extern on JS/Java/C#/Python), which is confusing for newcomers. Adds a notice in the Type API docs.

Changes

  • std/Type.hx: resolveClass doc now states:
    • the API is only guaranteed to work with types generated by the Haxe compiler
    • external (native) types declared with extern are not registered in the Haxe runtime and may not be resolvable by name

Verification

  • Syntax: comment-only change in a Haxe doc block; no code behaviour altered

Comment thread std/Type.hx
@TrueFurina

Copy link
Copy Markdown
Contributor Author

@Simn
Simn merged commit fe63b35 into HaxeFoundation:development Oct 27, 2026
1 check passed
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

Successfully merging this pull request may close these issues.

3 participants