clientcommands-scripting icon indicating copy to clipboard operation
clientcommands-scripting copied to clipboard

implement typedoc

Open ImUrX opened this issue 4 years ago • 7 comments

I dont like it that the docs are already generated but better discuss that here.

Ideas:

  • Implement Github Actions for generating docs
  • Check if the dir tree is alright

ImUrX avatar Oct 15 '21 18:10 ImUrX

@Earthcomputer thoughts?

ImUrX avatar Oct 15 '21 18:10 ImUrX

I would prefer this to be hosted on earthcomputer.net, which is mirrored to https://github.com/Earthcomputer/Earthcomputer.github.io

Earthcomputer avatar Oct 15 '21 18:10 Earthcomputer

If GitHub handles that domain you can make /clientcommands-scripting be a reference to /docs in here or you can just build the docs from that repository you mentioned

ImUrX avatar Oct 15 '21 19:10 ImUrX

now the definitions are on a .d.ts which could be published (with DefinitelyTyped) for usage in editors :p

ImUrX avatar Oct 16 '21 01:10 ImUrX

or copied into the "headers" folder in the autogenned typescript environment JS Macros creates, ps. i've created a javadoc doclet typescript generator you may want to look at...

wagyourtail avatar Oct 16 '21 02:10 wagyourtail

what do you mean by that, can you pass a link?

ImUrX avatar Oct 16 '21 19:10 ImUrX

https://github.com/wagyourtail/JsMacros/tree/main-1.17/buildSrc/src/main/java/xyz/wagyourtail/doclet/tsdoclet https://github.com/wagyourtail/JsMacros/tree/main-1.17/graalts

https://github.com/wagyourtail/JsMacros/releases/download/1.5.2/typescript-1.17.1.zip

wagyourtail avatar Oct 16 '21 20:10 wagyourtail