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.

Sign up for GitHub

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

Jump to bottom

Add ApplicationEgg#getDockerImages documentation #79

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Add ApplicationEgg#getDockerImages documentation #79

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
035d96b
add documentation
Goksi Apr 4, 2024
7a7453c
nit: add definite article
Goksi Apr 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/main/java/com/mattmalec/pterodactyl4j/application/entities/ApplicationEgg.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,11 @@ public interface ApplicationEgg extends Egg, ISnowflake {
*/
String getDockerImage();

/**
* The list of all Docker images associated with ApplicationEgg
Goksi marked this conversation as resolved.
Show resolved Hide resolved
*
* @return {@link java.util.List List} of {@link DockerImage DockerImage}
*/
List<DockerImage> getDockerImages();

/**
Expand Down
8 changes: 8 additions & 0 deletions src/main/java/com/mattmalec/pterodactyl4j/application/entities/DockerImage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Copy link
Owner

Choose a reason for hiding this comment

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

can you document the getName method too? should be good to approve after done :)


Expand Down
Loading