From 04eb23c2767440e4e4f76ea3e821d2947613619b Mon Sep 17 00:00:00 2001 From: Thomas Rubini <74205383+ThomasRubini@users.noreply.github.com> Date: Thu, 15 Dec 2022 19:55:58 +0100 Subject: [PATCH] fix javadoc --- src/main/java/fr/packageviewer/ArgParse.java | 1 - src/main/java/fr/packageviewer/DistributionEnum.java | 6 +++--- .../fr/packageviewer/distribution/ArchDistribution.java | 2 +- .../java/fr/packageviewer/parser/AsyncRequestsParser.java | 2 +- 4 files changed, 5 insertions(+), 6 deletions(-) diff --git a/src/main/java/fr/packageviewer/ArgParse.java b/src/main/java/fr/packageviewer/ArgParse.java index e477c3f..ccb9f01 100644 --- a/src/main/java/fr/packageviewer/ArgParse.java +++ b/src/main/java/fr/packageviewer/ArgParse.java @@ -17,7 +17,6 @@ public class ArgParse { * Get the command line argument given by the user, parse it with the parser and store it in the corresponding variable * @author Capelier-Marla * @param args the command line arguments given by the user - * @return void */ static void parseArguments(String[] args) { // create JCommander and CommandLineParams objects diff --git a/src/main/java/fr/packageviewer/DistributionEnum.java b/src/main/java/fr/packageviewer/DistributionEnum.java index a6fdbd9..997274f 100644 --- a/src/main/java/fr/packageviewer/DistributionEnum.java +++ b/src/main/java/fr/packageviewer/DistributionEnum.java @@ -21,8 +21,8 @@ public enum DistributionEnum { /** * Contructor for enums - * @param name - * @param distributionConstructor + * @param name the name of the distribution + * @param distributionConstructor the instance of the distribution * @author Capelier-Marla */ DistributionEnum(String name, Distribution distributionConstructor) { @@ -49,7 +49,7 @@ public enum DistributionEnum { /** * Get all distribution instances available in this enum - * @return the set of distribution instances + * @return the list of distribution instances */ public static List getAllDistributionsInstances() { // create the set that will be returned diff --git a/src/main/java/fr/packageviewer/distribution/ArchDistribution.java b/src/main/java/fr/packageviewer/distribution/ArchDistribution.java index 377066b..a94728d 100644 --- a/src/main/java/fr/packageviewer/distribution/ArchDistribution.java +++ b/src/main/java/fr/packageviewer/distribution/ArchDistribution.java @@ -37,7 +37,7 @@ public class ArchDistribution extends AsyncRequestsParser implements Distributio * * @param str String, the string to trim * @param trimAfterCharacters String, the character that delimits our string - * @return + * @return the string after being trimmed */ private static String trimAfterCharacters(String str, String trimAfterCharacters) { for (char c : trimAfterCharacters.toCharArray()) { diff --git a/src/main/java/fr/packageviewer/parser/AsyncRequestsParser.java b/src/main/java/fr/packageviewer/parser/AsyncRequestsParser.java index a877c4b..ec31226 100644 --- a/src/main/java/fr/packageviewer/parser/AsyncRequestsParser.java +++ b/src/main/java/fr/packageviewer/parser/AsyncRequestsParser.java @@ -34,7 +34,7 @@ public abstract class AsyncRequestsParser { * @param packageName String, The package's exact name * @return Pair of Package and Set of String */ - protected abstract CompletableFuture>> getPackageFromAPI(String name); + protected abstract CompletableFuture>> getPackageFromAPI(String packageName); /** * This function returns a fully completed package containing all