commit d81c8400af3127841d3c798f73b40ae5d83455d2 Author: Karsten Loesing karsten.loesing@gmx.net Date: Tue Aug 21 09:51:56 2018 +0200
Make a couple JavaDoc fixes. --- .../stats/servers/ConsensusStatsFileHandler.java | 20 ++++++++++---------- .../metrics/stats/servers/LoggingConfiguration.java | 2 -- .../servers/RelayDescriptorDatabaseImporter.java | 2 +- 3 files changed, 11 insertions(+), 13 deletions(-)
diff --git a/src/main/java/org/torproject/metrics/stats/servers/ConsensusStatsFileHandler.java b/src/main/java/org/torproject/metrics/stats/servers/ConsensusStatsFileHandler.java index ebbce60..f4f99cd 100644 --- a/src/main/java/org/torproject/metrics/stats/servers/ConsensusStatsFileHandler.java +++ b/src/main/java/org/torproject/metrics/stats/servers/ConsensusStatsFileHandler.java @@ -33,11 +33,11 @@ import java.util.logging.Logger;
/** * Generates statistics on the average number of relays and bridges per - * day. Accepts parse results from <code>RelayDescriptorParser</code> and - * <code>BridgeDescriptorParser</code> and stores them in intermediate - * result files <code>stats/consensus-stats-raw</code> and - * <code>stats/bridge-consensus-stats-raw</code>. Writes final results to - * <code>stats/consensus-stats</code> for all days for which at least half + * day. Accepts parse results from {@code RelayDescriptorParser} and + * {@code BridgeDescriptorParser} and stores them in intermediate + * result files {@code stats/consensus-stats-raw} and + * {@code stats/bridge-consensus-stats-raw}. Writes final results to + * {@code stats/consensus-stats} for all days for which at least half * of the expected consensuses or statuses are known. */ public class ConsensusStatsFileHandler { @@ -52,14 +52,14 @@ public class ConsensusStatsFileHandler { * Number of running bridges in a given bridge status. Map keys are the bridge * status time formatted as "yyyy-MM-dd HH:mm:ss", a comma, and the bridge * authority nickname, map values are lines as read from - * <code>stats/bridge-consensus-stats-raw</code>. + * {@code stats/bridge-consensus-stats-raw}. */ private SortedMap<String, String> bridgesRaw;
/** * Average number of running bridges per day. Map keys are dates * formatted as "yyyy-MM-dd", map values are the remaining columns as written - * to <code>stats/consensus-stats</code>. + * to {@code stats/consensus-stats}. */ private SortedMap<String, String> bridgesPerDay;
@@ -83,9 +83,9 @@ public class ConsensusStatsFileHandler {
/** * Initializes this class, including reading in intermediate results - * files <code>stats/consensus-stats-raw</code> and - * <code>stats/bridge-consensus-stats-raw</code> and final results file - * <code>stats/consensus-stats</code>. + * files {@code stats/consensus-stats-raw} and + * {@code stats/bridge-consensus-stats-raw} and final results file + * {@code stats/consensus-stats}. */ public ConsensusStatsFileHandler(String connectionUrl, File bridgesDir, File statsDirectory, diff --git a/src/main/java/org/torproject/metrics/stats/servers/LoggingConfiguration.java b/src/main/java/org/torproject/metrics/stats/servers/LoggingConfiguration.java index f14241b..a11c6c4 100644 --- a/src/main/java/org/torproject/metrics/stats/servers/LoggingConfiguration.java +++ b/src/main/java/org/torproject/metrics/stats/servers/LoggingConfiguration.java @@ -20,7 +20,6 @@ import java.util.logging.Logger; * * <p>Log levels used by ERNIE:</p> * - * <p> * <ul> * <li>SEVERE: An event made it impossible to continue program execution. * WARNING: A potential problem occurred that requires the operator to @@ -34,7 +33,6 @@ import java.util.logging.Logger; * using FINER.</li> * <li>FINEST: Most detailed debug messages. Not used.</li> * </ul> - * </p> */ public class LoggingConfiguration {
diff --git a/src/main/java/org/torproject/metrics/stats/servers/RelayDescriptorDatabaseImporter.java b/src/main/java/org/torproject/metrics/stats/servers/RelayDescriptorDatabaseImporter.java index 38afeec..750e231 100644 --- a/src/main/java/org/torproject/metrics/stats/servers/RelayDescriptorDatabaseImporter.java +++ b/src/main/java/org/torproject/metrics/stats/servers/RelayDescriptorDatabaseImporter.java @@ -173,7 +173,7 @@ public final class RelayDescriptorDatabaseImporter {
/** * Set of fingerprints that we imported for the valid-after time in - * <code>lastCheckedStatusEntries</code>. + * {@code lastCheckedStatusEntries}. */ private Set<String> insertedStatusEntries = new HashSet<>();