From 9e0001c4f627967c929ae9fb5c64898ec0143b56 Mon Sep 17 00:00:00 2001
From: catbref <misc-github@talk2dom.com>
Date: Thu, 7 May 2020 10:22:44 +0100
Subject: [PATCH] Improved comments, variable names, etc. for some repository
 interfaces

---
 .../qortal/repository/AccountRepository.java    | 17 ++++++++++++++++-
 .../org/qortal/repository/AssetRepository.java  |  2 +-
 .../org/qortal/repository/NameRepository.java   |  2 +-
 3 files changed, 18 insertions(+), 3 deletions(-)

diff --git a/src/main/java/org/qortal/repository/AccountRepository.java b/src/main/java/org/qortal/repository/AccountRepository.java
index 7f82ac9b..f6997fae 100644
--- a/src/main/java/org/qortal/repository/AccountRepository.java
+++ b/src/main/java/org/qortal/repository/AccountRepository.java
@@ -82,7 +82,8 @@ public interface AccountRepository {
 	 */
 	public void setMintedBlockCount(AccountData accountData) throws DataException;
 
-	/** Modifies account's minted block count only.
+	/**
+	 * Modifies account's minted block count only.
 	 * <p>
 	 * @return 2 if minted block count updated, 1 if block count set to delta, 0 if address not found.
 	 */
@@ -96,18 +97,32 @@ public interface AccountRepository {
 
 	// Account balances
 
+	/**
+	 * Returns account's balance for specific assetID.
+	 * <p>
+	 * Note: returns <tt>null</tt> if account has no/zero balance for
+	 * <i>that specific assetID</i>. This does not mean
+	 * the account itself does not exist.
+	 */
 	public AccountBalanceData getBalance(String address, long assetId) throws DataException;
 
+	/** How to order results when fetching asset balances. */
 	public enum BalanceOrdering {
+		/** assetID first, then balance, then account address */
 		ASSET_BALANCE_ACCOUNT,
+		/** account address first, then assetID */
 		ACCOUNT_ASSET,
+		/** assetID first, then account address */
 		ASSET_ACCOUNT
 	}
 
+	/** Returns all account balances for given assetID, optionally excluding zero balances. */
 	public List<AccountBalanceData> getAssetBalances(long assetId, Boolean excludeZero) throws DataException;
 
+	/** Returns account balances for matching addresses / assetIDs, optionally excluding zero balances, with pagination, used by API. */
 	public List<AccountBalanceData> getAssetBalances(List<String> addresses, List<Long> assetIds, BalanceOrdering balanceOrdering, Boolean excludeZero, Integer limit, Integer offset, Boolean reverse) throws DataException;
 
+	/** Modifies account's asset balance by <tt>deltaBalance</tt>. */
 	public void modifyAssetBalance(String address, long assetId, long deltaBalance) throws DataException;
 
 	public void save(AccountBalanceData accountBalanceData) throws DataException;
diff --git a/src/main/java/org/qortal/repository/AssetRepository.java b/src/main/java/org/qortal/repository/AssetRepository.java
index 3aa70451..94b1ceb0 100644
--- a/src/main/java/org/qortal/repository/AssetRepository.java
+++ b/src/main/java/org/qortal/repository/AssetRepository.java
@@ -25,7 +25,7 @@ public interface AssetRepository {
 		return getAllAssets(null, null, null);
 	}
 
-	public List<Long> getRecentAssetIds(long start) throws DataException;
+	public List<Long> getRecentAssetIds(long startTimestamp) throws DataException;
 
 	// For a list of asset holders, see AccountRepository.getAssetBalances
 
diff --git a/src/main/java/org/qortal/repository/NameRepository.java b/src/main/java/org/qortal/repository/NameRepository.java
index 2dff8df1..e056fb1d 100644
--- a/src/main/java/org/qortal/repository/NameRepository.java
+++ b/src/main/java/org/qortal/repository/NameRepository.java
@@ -28,7 +28,7 @@ public interface NameRepository {
 		return getNamesByOwner(address, null, null, null);
 	}
 
-	public List<String> getRecentNames(long start) throws DataException;
+	public List<String> getRecentNames(long startTimestamp) throws DataException;
 
 	public void save(NameData nameData) throws DataException;