Please provide proper javadoc #5050
Unanswered
TetraTheta
asked this question in
Ideas and Feature Suggestions
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Wiki is already explaning 'How to use EssentialsX as dependency' in here. But in order to use EssentialsX as dependency, Javadoc is required. Wiki doesn't provide any link of Javadoc, so I had to ask in M.O.S.S. to get the Javadoc link.
Wiki should also include a link to Javadoc too if it provides information of how to use EssentialsX as dependency.
Also, the Javadoc is not well documented. I'll give you an example of what I've been through.
I wanted to teleport a player to overworld's spawn point when the player is marked as AFK because of inactivity in EssentialsX. I looked at the Javadoc and found AfkStatusChangeEvent. But I didn't get what
boolean value
andAfkStatusChangeEvent.Cause
in constructors means.What does
value
means? If it istrue
, does it means that the user is now marked as AFK? or the opposite?What exact value should I use to detect if the user is marked as AFK because of inactivity? Is it
AfkStatusChangeEvent.Cause.ACTIVITY
?Also I don't see any description of those methods in the event too.
I saw an answer in #4019 saying:
But as Wiki is now providing information of using EssentialsX as dependency, well-documented Javadoc should also be provided too. To me, this situation feels like 'Here is the entrance to the maze. Find the exit on your own'. Not to offense, but I hope you understand how desperate I felt when I lost what and how to use in Javadoc.
Beta Was this translation helpful? Give feedback.
All reactions