From 035d96bf9c217210b2b399466fd612f8cf351cc1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vuka=C5=A1in=20Leki=C4=87?= Date: Thu, 4 Apr 2024 19:06:29 +0200 Subject: [PATCH 1/2] add documentation --- .../application/entities/ApplicationEgg.java | 5 +++++ .../pterodactyl4j/application/entities/DockerImage.java | 8 ++++++++ 2 files changed, 13 insertions(+) diff --git a/src/main/java/com/mattmalec/pterodactyl4j/application/entities/ApplicationEgg.java b/src/main/java/com/mattmalec/pterodactyl4j/application/entities/ApplicationEgg.java index 1b56249..3ccb133 100644 --- 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 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 index 22b37ad..3728411 100644 --- 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}. + * + *
This should contain all information provided from the {@link ApplicationEgg ApplicationEgg} instance about + * available Docker images. + * + * @see ApplicationEgg#getDockerImages() + */ public interface DockerImage { String getName(); From 7a7453c7ef9bd8fc09b059a9e1a5c48b9a9815bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vuka=C5=A1in=20Leki=C4=87?= Date: Sun, 7 Apr 2024 13:17:38 +0200 Subject: [PATCH 2/2] nit: add definite article --- .../pterodactyl4j/application/entities/ApplicationEgg.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/com/mattmalec/pterodactyl4j/application/entities/ApplicationEgg.java b/src/main/java/com/mattmalec/pterodactyl4j/application/entities/ApplicationEgg.java index 3ccb133..bb9796b 100644 --- a/src/main/java/com/mattmalec/pterodactyl4j/application/entities/ApplicationEgg.java +++ b/src/main/java/com/mattmalec/pterodactyl4j/application/entities/ApplicationEgg.java @@ -75,7 +75,7 @@ public interface ApplicationEgg extends Egg, ISnowflake { String getDockerImage(); /** - * The list of all Docker images associated with ApplicationEgg + * The list of all Docker images associated with the ApplicationEgg * * @return {@link java.util.List List} of {@link DockerImage DockerImage} */