factions icon indicating copy to clipboard operation
factions copied to clipboard

Javadoc for API persistents and events

Open ickerio opened this issue 3 years ago • 3 comments

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 avatar Jun 05 '22 02:06 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

ickerio avatar Jul 10 '22 13:07 ickerio

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 (4c6e25422c0a0f38dfd4a126c0e9944da9057099). I kept the old workflow just in case, though.

BlueZeeKing avatar Jul 10 '22 17:07 BlueZeeKing

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

PyPylia avatar Jul 10 '22 23:07 PyPylia