Javadoc fixes and javadoc defanging.
This commit is contained in:
@@ -95,6 +95,7 @@
|
||||
<link>http://samskivert.github.com/samskivert/apidocs/</link>
|
||||
<link>http://docs.guava-libraries.googlecode.com/git/javadoc/</link>
|
||||
</links>
|
||||
<additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
|
||||
@@ -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<Date, IntIntMap> getSubscriptionInfo ()
|
||||
{
|
||||
|
||||
@@ -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)
|
||||
@@ -684,8 +684,8 @@ 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.
|
||||
* day using a LinkedHashMap ({@code Date => Count}) to preserve the date ordering returned by
|
||||
* the database.
|
||||
*/
|
||||
public Map<Date,Integer> getAffiliateRegistrationCounts (Date start, Date end, int siteId)
|
||||
throws PersistenceException
|
||||
@@ -696,8 +696,8 @@ 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.
|
||||
* 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<Date, Integer> 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<Date, Integer> 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
|
||||
|
||||
@@ -36,7 +36,6 @@ public class RepositoryManager {
|
||||
|
||||
/**
|
||||
* Initialize a new set of repositories.
|
||||
* @param config
|
||||
*/
|
||||
public RepositoryManager (Config config)
|
||||
throws PersistenceException
|
||||
|
||||
@@ -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<Date, IntIntMap> getSubscriptionInfo ()
|
||||
{
|
||||
|
||||
@@ -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)
|
||||
{
|
||||
|
||||
@@ -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<String, Integer> loadUserIds (ExternalAuther auther, Collection<String> 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<Integer, String> loadExternalIds (ExternalAuther auther, Collection<Integer> oooIds)
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user