From 2e9b1c82706d62b170a9522133484a66bc3884bd Mon Sep 17 00:00:00 2001 From: Michael Bayne Date: Sun, 18 Dec 2016 09:48:44 -0800 Subject: [PATCH] Javadoc fixes and javadoc defanging. --- pom.xml | 1 + .../threerings/user/ConversionRepository.java | 4 +-- .../threerings/user/OOOUserRepository.java | 30 +++++++++---------- .../threerings/user/RepositoryManager.java | 1 - .../user/depot/ConversionRepository.java | 4 +-- .../user/depot/DepotUserRepository.java | 2 +- .../user/depot/ExternalAuthRepository.java | 8 ++--- 7 files changed, 25 insertions(+), 25 deletions(-) diff --git a/pom.xml b/pom.xml index 5a8ca90..ec86373 100644 --- a/pom.xml +++ b/pom.xml @@ -95,6 +95,7 @@ http://samskivert.github.com/samskivert/apidocs/ http://docs.guava-libraries.googlecode.com/git/javadoc/ + -Xdoclint:all -Xdoclint:-missing diff --git a/src/main/java/com/threerings/user/ConversionRepository.java b/src/main/java/com/threerings/user/ConversionRepository.java index 948e2a4..a21f27b 100644 --- a/src/main/java/com/threerings/user/ConversionRepository.java +++ b/src/main/java/com/threerings/user/ConversionRepository.java @@ -132,8 +132,8 @@ public class ConversionRepository extends JORARepository } /** - * Returns all of our subscription info. Date -> IntIntMap, - * IntIntMap: SiteId -> Subscribers. SiteId 0 is a total of all sites. + * Returns all of our subscription info. {@code Date -> SiteId -> Subscribers}. SiteId 0 is a + * total of all sites. */ public Map getSubscriptionInfo () { diff --git a/src/main/java/com/threerings/user/OOOUserRepository.java b/src/main/java/com/threerings/user/OOOUserRepository.java index 863a74a..8a7fa9f 100644 --- a/src/main/java/com/threerings/user/OOOUserRepository.java +++ b/src/main/java/com/threerings/user/OOOUserRepository.java @@ -596,7 +596,7 @@ public class OOOUserRepository extends UserRepository } /** - * Return a mapping of affliate ids -> count of users who registered within the specified date + * Return a mapping of affliate ids to count of users who registered within the specified date * range (inclusive). */ public IntIntMap getAffiliateRegistrationCount (Date start, Date end) @@ -607,7 +607,7 @@ public class OOOUserRepository extends UserRepository } /** - * Return a mapping of affliate ids -> currently or once subscribed users who registered within + * Return a mapping of affliate ids to currently or once subscribed users who registered within * the specified date range (inclusive). * * @param column the column that denotes subscription for the desired site (currently only @@ -622,7 +622,7 @@ public class OOOUserRepository extends UserRepository } /** - * Return a mapping of affliate ids -> users that have purchased coins and who registered + * Return a mapping of affliate ids to users that have purchased coins and who registered * within the specified date range (inclusive). */ public IntIntMap getAffiliateCoinBuyerCount (Date start, Date end) @@ -634,7 +634,7 @@ public class OOOUserRepository extends UserRepository } /** - * Return a mapping of affliate ids -> users that have purchased time and who registered within + * Return a mapping of affliate ids to users that have purchased time and who registered within * the specified date range (inclusive). */ public IntIntMap getAffiliateTimeBuyerCount (Date start, Date end) @@ -683,9 +683,9 @@ public class OOOUserRepository extends UserRepository } /** - * Get the number of created user accounts in the specified date range. Returns the count by - * day using a LinkedHashMap (Date => Count) to preserve the date ordering returned by the - * database. + * Get the number of created user accounts in the specified date range. Returns the count by + * day using a LinkedHashMap ({@code Date => Count}) to preserve the date ordering returned by + * the database. */ public Map getAffiliateRegistrationCounts (Date start, Date end, int siteId) throws PersistenceException @@ -695,9 +695,9 @@ public class OOOUserRepository extends UserRepository } /** - * Get the number of subscriber user accounts created in the specified date range. Returns the - * count by day using a LinkedHashMap (Date => Count) to preserve the date ordering returned by - * the database. + * Get the number of subscriber user accounts created in the specified date range. Returns the + * count by day using a LinkedHashMap ({@code Date => Count}) to preserve the date ordering + * returned by the database. * * @param siteId (aka affiliateId) the affiliate site to look up. * @param column the column that denotes subscription for the desired site (currently only @@ -713,8 +713,8 @@ public class OOOUserRepository extends UserRepository } /** - * Get the number of coin-buying user accounts created in the specified date range. Returns - * the count by day using a LinkedHashMap (Date => Count) to preserve the date ordering + * Get the number of coin-buying user accounts created in the specified date range. Returns the + * count by day using a LinkedHashMap ({@code Date => Count}) to preserve the date ordering * returned by the database. */ public Map getAffiliateCoinBuyerCounts (Date start, Date end, int siteId) @@ -728,8 +728,8 @@ public class OOOUserRepository extends UserRepository /** * Get the number of coin-buying user accounts created in the specified date range. * - * @return the count by day using a LinkedHashMap (Date => Count) to preserve the date ordering - * returned by the database. + * @return the count by day using a LinkedHashMap ({@code Date => Count}) to preserve the date + * ordering returned by the database. */ public Map getAffiliateTimeBuyerCounts (Date start, Date end, int siteId) throws PersistenceException @@ -1455,7 +1455,7 @@ public class OOOUserRepository extends UserRepository } /** - * Add the userId -> machIdent mapping to the database. + * Add the {@code userId -> machIdent} mapping to the database. */ public void addUserIdent (int userId, String machIdent) throws PersistenceException diff --git a/src/main/java/com/threerings/user/RepositoryManager.java b/src/main/java/com/threerings/user/RepositoryManager.java index c4b934c..dfa4717 100644 --- a/src/main/java/com/threerings/user/RepositoryManager.java +++ b/src/main/java/com/threerings/user/RepositoryManager.java @@ -36,7 +36,6 @@ public class RepositoryManager { /** * Initialize a new set of repositories. - * @param config */ public RepositoryManager (Config config) throws PersistenceException diff --git a/src/main/java/com/threerings/user/depot/ConversionRepository.java b/src/main/java/com/threerings/user/depot/ConversionRepository.java index 6d2d4d8..37100c2 100644 --- a/src/main/java/com/threerings/user/depot/ConversionRepository.java +++ b/src/main/java/com/threerings/user/depot/ConversionRepository.java @@ -96,8 +96,8 @@ public class ConversionRepository extends DepotRepository } /** - * Returns all of our subscription info. Date -> IntIntMap, - * IntIntMap: SiteId -> Subscribers. SiteId 0 is a total of all sites. + * Returns all of our subscription info. {@code Date -> SiteId -> Subscribers}. SiteId 0 is a + * total of all sites. */ public Map getSubscriptionInfo () { diff --git a/src/main/java/com/threerings/user/depot/DepotUserRepository.java b/src/main/java/com/threerings/user/depot/DepotUserRepository.java index 49354b2..f37ee62 100644 --- a/src/main/java/com/threerings/user/depot/DepotUserRepository.java +++ b/src/main/java/com/threerings/user/depot/DepotUserRepository.java @@ -379,7 +379,7 @@ public class DepotUserRepository extends DepotRepository } /** - * Add the userId -> machIdent mapping to the database. + * Add the {@code userId -> machIdent} mapping to the database. */ public void addUserIdent (int userId, String machIdent) { diff --git a/src/main/java/com/threerings/user/depot/ExternalAuthRepository.java b/src/main/java/com/threerings/user/depot/ExternalAuthRepository.java index 05318b2..311e15a 100644 --- a/src/main/java/com/threerings/user/depot/ExternalAuthRepository.java +++ b/src/main/java/com/threerings/user/depot/ExternalAuthRepository.java @@ -78,8 +78,8 @@ public class ExternalAuthRepository extends DepotRepository } /** - * Loads a mapping of (exid -> ooouser id) for all members in the supplied list that are found - * in the database. + * Loads a mapping of ({@code exid -> ooouser id}) for all members in the supplied list that + * are found in the database. */ public Map loadUserIds (ExternalAuther auther, Collection externalIds) { @@ -94,8 +94,8 @@ public class ExternalAuthRepository extends DepotRepository } /** - * Loads a mapping of (ooouser id -> exid) for all members in the supplied list that are found - * in the database. + * Loads a mapping of ({@code ooouser id -> exid}) for all members in the supplied list that + * are found in the database. */ public Map loadExternalIds (ExternalAuther auther, Collection oooIds) {