Adding Documentation #1
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
EmiCB
commented
Jul 30, 2022
EmiCB
commented
- Added README.md
- Added JavaDoc to plugin files
Geph
approved these changes
Oct 12, 2022
Member
Geph
left a comment
Geph
left a comment
There was a problem hiding this comment.
Yay, I can figure out how it works now!
jackah2
requested changes
Oct 12, 2022
Member
jackah2
left a comment
jackah2
left a comment
There was a problem hiding this comment.
Make sure you merge in the new changes or rebase 👍
| /** The player's previous location. */ | ||
| private Location prevLocation; | ||
|
|
||
| /** The Observe event. */ |
Member
There was a problem hiding this comment.
Suggested change
| /** The Observe event. */ | |
| /** The current Observe event being photographed. */ |
| It should show up in the target directory. Make sure to update your version number. | ||
|
|
||
| ## Dependencies | ||
| - [WHIMC Observations](https://github.com/whimc/Observations) |
Member
There was a problem hiding this comment.
Worth noting that you currently have to locally install observations to be able to compile the plugin
| ## Dependencies | ||
| - [WHIMC Observations](https://github.com/whimc/Observations) | ||
|
|
||
| ## Commands |
Member
There was a problem hiding this comment.
I've since added a couple new commands
| * @return The newly registered CameraOperator. | ||
| */ | ||
| public static Optional<CameraOperator> registerCameraOperator(Photographer plugin, Player player, SocketIOClient client) { | ||
| // check if player and client are present |
Member
There was a problem hiding this comment.
Suggested change
| // check if player and client are present | |
| // check if player or client are already registered |
Member
|
@Emi I took the contents of your readme here and merged them in on a different branch. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.