Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation #138

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Adding documentation #138

wants to merge 5 commits into from

Conversation

dalemorris2021
Copy link
Contributor

Added and edited documentation and edited coding style

@Xavbeat03 Xavbeat03 added this to the Project Completion milestone Dec 6, 2023
@Xavbeat03 Xavbeat03 added the documentation Improvements or additions to documentation label Dec 6, 2023
@Xavbeat03 Xavbeat03 linked an issue Dec 6, 2023 that may be closed by this pull request
# Conflicts:
#	src/main/java/team/rocket/Enums/Direction.java
#	src/main/java/team/rocket/IO/UI.java
Copy link
Contributor

@Xavbeat03 Xavbeat03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If something was a javadoc before don't just convert it to a comment. Also this appears to be a bunch of formatting changes rather then adding documentation.

*/
public enum Direction {
/**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No point in getting rid of these javadocs, they're necessary for the API

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

with mention towards the Direction

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is half of this just adding spaces?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure this change was necessary.

*/
public class TerminalFlagRequest {
/**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These were intentionally made to be javadocs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

update miscellaneous documentation
3 participants