Eh added a bit of docs before I make a bigger pr with way more docs #53

shmezi · 2022-05-19T07:41:30Z

no clue what I did but hopefully this works ?

lokerhp · 2022-05-19T08:24:38Z

src/main/java/com/mattmalec/pterodactyl4j/DataType.java

 	B ((byte) 0, 1,                  "Byte"),
+	/**
+	 * DataType format for Kilo-Bytes


Can’t this be just Kilobytes? (Same for gb / mb)

Could yes, Just wanted to be clear, really just preference-based feel free to change it tho.

Since this is your PR, you would have to be the one to change it

mattmalec

I'm noticing that quite a bit of code was reformatted in a way that breaks a lot of Javadoc comments that I had written out.

I'm trying to think of there's an easier way to fix it besides manually going through all the files.

shmezi · 2022-05-19T14:02:57Z

Do you use a plugin to format or something, if so maybe I can just add it so it fixes that

mattmalec

Overall, I'm pretty impressed you actually went through all these files and was able to document it. There's a few parts that can be picked up and I realize they're kinda nitty, but these are the types of things that can make you stand out when writing docs.

mattmalec · 2022-05-26T17:44:59Z

src/main/java/com/mattmalec/pterodactyl4j/DataType.java

 	MB((byte) 2, 1048576,            "Megabyte"),
+	/**
+	 * DataType format for Giga-Bytes


For stuff like this, you don't need to document each individual enum. They're pretty self-explanatory as it is.

mattmalec · 2022-05-26T17:45:30Z

src/main/java/com/mattmalec/pterodactyl4j/UtilizationState.java

    STARTING,
+    /**
+     * Represents when the server is online


In this scenario, this makes sense to document the enum. I like what you did here :)

mattmalec · 2022-05-26T17:47:08Z

src/main/java/com/mattmalec/pterodactyl4j/client/entities/ClientServer.java

@@ -27,94 +28,130 @@
 import java.util.Set;
 import java.util.UUID;

+/**
+ * Represents a {@link PteroClient}'s server


I would check how I did this with the ApplicationServer implementation. I'd ideally like to keep everything using the same conventions if possible.

I'm also kinda confused why this is all spaced out now.

mattmalec · 2022-05-26T17:48:27Z

src/main/java/com/mattmalec/pterodactyl4j/client/entities/ClientSubuser.java

@@ -22,11 +22,31 @@
 import java.time.OffsetDateTime;
 import java.util.UUID;

+/**
+ * Represents a sub-user pm a {@link ClientServer}


Spelling mistake here. Also, like mentioned earlier, I would check how it's documented with User

mattmalec · 2022-05-26T17:50:36Z

src/main/java/com/mattmalec/pterodactyl4j/client/entities/ClientSubuser.java

    boolean has2FA();
+
+    /**
+     * Gets the uuid of the {@link ClientSubuser}


The description and return value are kinda recursive here and explain the same thing. It's important to notate if this method can return null at all.

Suggested change

* Gets the uuid of the {@link ClientSubuser}

* The UUID of the Server.

*

* @return Never-null {@link java.util.UUID} containing the Subuser's UUID.

*/

UUID getUUID();

mattmalec · 2022-05-26T22:28:14Z

src/main/java/com/mattmalec/pterodactyl4j/client/entities/Utilization.java

 	default String getMemoryFormatted(DataType dataType) {
 		return String.format("%.2f %s", getMemory() / (dataType.getMbValue() * Math.pow(2, 20)), dataType.name());
 	}
+	/**
+	 * Get the current disk space usage


This stuff is very recursive. We also don't want to start our doc with "Get" if weren't not actually running any logic to actually "get" the value, we're just returning data that's already there.

Suggested change

* Get the current disk space usage

* The raw amount of disk space currently being used by this Server.

* @return The raw amount of disk space, usually in {@link DataType#MB} form

mattmalec · 2022-05-26T22:32:54Z

src/main/java/com/mattmalec/pterodactyl4j/client/entities/Utilization.java

@@ -42,15 +54,37 @@ default String getUptimeFormatted() {
 			return String.format("%.0fh %.0fm %.0fs", hours, minutes, seconds);
 	}

+	/**
+	 * Get the current ram usage


Stuff like this, same thing as my previous comment on disk space.

mattmalec · 2022-05-26T22:45:16Z

src/main/java/com/mattmalec/pterodactyl4j/application/entities/Nest.java

@@ -22,6 +22,9 @@
 import java.util.List;
 import java.util.Optional;

+/**
+ * Represents a Pterodactyl {@link Nest}


This can be explained better too. I should have some comments around the review saying the same thing.

mattmalec · 2022-05-26T22:45:40Z

src/main/java/com/mattmalec/pterodactyl4j/application/entities/ApplicationUser.java


 import java.util.List;
 import java.util.Locale;
 import java.util.UUID;

+/**
+ * Represents a user on a {@link ApplicationServer} server


This can be explained better too. Also still confused on why these lines are spread out.

mattmalec · 2022-05-26T22:46:41Z

src/main/java/com/mattmalec/pterodactyl4j/UtilizationState.java

@@ -17,18 +17,29 @@
 package com.mattmalec.pterodactyl4j;

 /**
- * Represents a servers state.
+ * Represents a server's state.


shmezi · 2022-05-27T14:08:06Z

Ok nice, sorry for any mistakes.. first pr I've made on open source stuff..

mattmalec · 2022-05-27T14:35:55Z

No need to apologize! It's hard to get a PR right the first time on an open source project. My biggest nit is consistency - making sure the docs are consistent and helpful across the entire project. I meant it when I said I was impressed, a couple of things to clean up, but you really did a great job :)

shmezi added 2 commits May 16, 2022 22:33

Docs added

5d66fd6

Merge remote-tracking branch 'origin/develop' into develop

cdad2d7

lokerhp reviewed May 19, 2022

View reviewed changes

mattmalec requested changes May 19, 2022

View reviewed changes

mattmalec requested changes May 26, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Eh added a bit of docs before I make a bigger pr with way more docs #53

Eh added a bit of docs before I make a bigger pr with way more docs #53

shmezi commented May 19, 2022

lokerhp May 19, 2022 •

edited

Loading

shmezi May 19, 2022

mattmalec May 19, 2022

mattmalec left a comment

shmezi commented May 19, 2022

mattmalec left a comment

mattmalec May 26, 2022

mattmalec May 26, 2022

mattmalec May 26, 2022

mattmalec May 26, 2022

mattmalec May 26, 2022

mattmalec May 26, 2022

mattmalec May 26, 2022

mattmalec May 26, 2022

mattmalec May 26, 2022

mattmalec May 26, 2022

mattmalec May 26, 2022

shmezi commented May 27, 2022

mattmalec commented May 27, 2022

-     * Gets the uuid of the {@link ClientSubuser}
+	 * The UUID of the Server.
+	 *
+	 * @return Never-null {@link java.util.UUID} containing the Subuser's UUID.
+	 */
+	UUID getUUID();

	* Get the current disk space usage
	* The raw amount of disk space currently being used by this Server.
	* @return The raw amount of disk space, usually in {@link DataType#MB} form

Eh added a bit of docs before I make a bigger pr with way more docs #53

Are you sure you want to change the base?

Eh added a bit of docs before I make a bigger pr with way more docs #53

Conversation

shmezi commented May 19, 2022

lokerhp May 19, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattmalec left a comment

Choose a reason for hiding this comment

shmezi commented May 19, 2022

mattmalec left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shmezi commented May 27, 2022

mattmalec commented May 27, 2022

lokerhp May 19, 2022 •

edited

Loading