Javadoc for API persistents and events

[ickerio]

Is your feature request related to a problem?

Would be good to generate a javadoc of our API so that other mods can hook in

Describe the solution you'd like.

A javadoc would be ideal or just a wiki page outlining the events and persistent objects

Describe alternatives you've considered.

Having no docs but means its hard to extend this mod

Other

No response

[ickerio]

@BlueZeeKing has set this up (https://ickerio.github.io/factions/index.html) I reckon the Github Action javadoc could be merged into and ran on the publish action, though not a massive priority. Just need to write comments now

[BlueZeeKing]

I reckon the Github Action javadoc could be merged into and ran on the publish action

I just updated the publish workflow to include the Javadoc (4c6e254). I kept the old workflow just in case, though.

[PyPylia]

I can definitely work on documenting everything with Javadocs. Once the Javadoc comments are finished I'll close this issue.