From faa899670c2bf61b768b061e4970ce45cbe81c30 Mon Sep 17 00:00:00 2001 From: Mike Pope Date: Sun, 1 May 2022 12:13:14 +0930 Subject: [PATCH] Cosmetic javadoc. --- .../freecol/client/gui/LoadingSavegameInfo.java | 8 +++++++- src/net/sf/freecol/tools/TranslationReport.java | 17 ----------------- src/overview.html | 1 - 3 files changed, 7 insertions(+), 19 deletions(-) diff --git a/src/net/sf/freecol/client/gui/LoadingSavegameInfo.java b/src/net/sf/freecol/client/gui/LoadingSavegameInfo.java index d8b5e9686..7a8ab2d7e 100644 --- a/src/net/sf/freecol/client/gui/LoadingSavegameInfo.java +++ b/src/net/sf/freecol/client/gui/LoadingSavegameInfo.java @@ -51,7 +51,8 @@ public class LoadingSavegameInfo { /** * Get the selected address; - * @return + * + * @return The {@code InetAddress}. */ public InetAddress getAddress() { return address; @@ -75,6 +76,11 @@ public class LoadingSavegameInfo { return serverName; } + /** + * Is this a public server? + * + * @return True if this is a public server. + */ public boolean isPublicServer() { return publicServer; } diff --git a/src/net/sf/freecol/tools/TranslationReport.java b/src/net/sf/freecol/tools/TranslationReport.java index 8163163a4..f46009df0 100644 --- a/src/net/sf/freecol/tools/TranslationReport.java +++ b/src/net/sf/freecol/tools/TranslationReport.java @@ -222,13 +222,6 @@ public class TranslationReport { /** * Sets inVariable as needed - * - * @param superfluousVariables - * @param key - * @param value - * @param propertiesValue - * @param lastIndex - * @param inVariable */ private static void isInVariable(ArrayList superfluousVariables, String key, String value, String propertiesValue, int lastIndex, boolean inVariable) { for (int index = 0; index < propertiesValue.length() - 1; index++) { @@ -253,9 +246,6 @@ public class TranslationReport { /** * Produces a shorter name. - * - * @param localFile - * @return */ private static StringBuilder shortenName(String localFile) { StringBuilder out = new StringBuilder(5); @@ -269,9 +259,6 @@ public class TranslationReport { /** * Adds space after a number. - * - * @param number - * @return */ private static StringBuilder prettyPrint(int number) { StringBuilder output = new StringBuilder(4); @@ -283,10 +270,6 @@ public class TranslationReport { } - /** - * @param missingKeys - * @return - */ private static TreeSet sort(ArrayList missingKeys) { TreeSet sorted = new TreeSet<>(); sorted.addAll(missingKeys); diff --git a/src/overview.html b/src/overview.html index 969559526..0acde3399 100644 --- a/src/overview.html +++ b/src/overview.html @@ -1,7 +1,6 @@
This is the javadoc generated code documentation for FreeCol. -

Overview

The {@link net.sf.freecol main package} contains the class {@link net.sf.freecol.FreeCol} which is responsible for handling