HaxeFoundation / HaxeFoundation/haxe

[ENHANCEMENT] [jvm] Add --java-lib-sources argument to support JavaDocs

Open
#11,375 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Haxe
Stars
6.9k
Forks
715
Avg merge
2d 2h
Merged PRs (30d)
11

Description

I'm wondering if it would be possible to add the ability for VSCode to display JavaDocs for extern classes provided by `--java-lib-extern` in the current build context.

I believe this would have to involve the ability to include and reference a sources JAR. I don't know if providing a sources JAR could improve the generation of `--dump`s as well.

Currently, the only way to provide documentation for external classes is to manually create `extern` classes which `@:native` to the desired class, and then document those. This is a large amount of work for larger libraries and is mostly redundant when Haxe can generate externs automatically, and when JavaDocs already exist.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.