add documentation

mattmalec · Apr 4, 2024 · 035d96b · 035d96b
1 parent 844ffdc
commit 035d96b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/src/main/java/com/mattmalec/pterodactyl4j/application/entities/ApplicationEgg.java b/src/main/java/com/mattmalec/pterodactyl4j/application/entities/ApplicationEgg.java
@@ -74,6 +74,11 @@ public interface ApplicationEgg extends Egg, ISnowflake {
 	 */
 	String getDockerImage();
 
+	/**
+	 * The list of all Docker images associated with ApplicationEgg
+	 *
+	 * @return {@link java.util.List List} of {@link DockerImage DockerImage}
+	 */
 	List<DockerImage> getDockerImages();
 
 	/**

diff --git a/src/main/java/com/mattmalec/pterodactyl4j/application/entities/DockerImage.java b/src/main/java/com/mattmalec/pterodactyl4j/application/entities/DockerImage.java
@@ -16,6 +16,14 @@
 
 package com.mattmalec.pterodactyl4j.application.entities;
 
+/**
+ * Represents a Pterodactyl {@link com.mattmalec.pterodactyl4j.application.entities.DockerImage DockerImage}.
+ *
+ * <br> This should contain all information provided from the {@link ApplicationEgg ApplicationEgg} instance about
+ * available Docker images.
+ *
+ * @see ApplicationEgg#getDockerImages()
+ */
 public interface DockerImage {
 	String getName();