BowlerHatLLC / BowlerHatLLC/vscode-as3mxml

ASDoc Generation either as HTML, or as XML to insert into SWC

Open
#652 11 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
282
Forks
45
PR merge metrics
No merged PRs in 30d

Description

When I'm building a library, I often want to include its ASDoc information in the built SWC. There is currently no way to do that, to my knowledge. I took a peek at the code that might be required for that and honestly can't imagine how I would accomplish this.
The main way I could see this being done is by adding a setting to the asconfig JSON when the type is "lib" that would generate and include the ASDoc, but I could also see the merit of a separate task for it (that could be used with any asconfig), in case the user wants to build and release, for example, the HTML that comes out of the tool. I'm making this an issue rather than a PR because I don't know the best way to implement either; if given an idea, I'm happy to work on it myself. My main guess for how to implement it would be to simply change the compiler path in ASConfigC, but I'd like to make sure that that's what you would do and/or accept first.

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.