add javadoc documentation for upload/download rate-limit functionality

mpetazzoni · Jul 22, 2013 · b15ea5e · b15ea5e · antonio1799 · Nov 7, 2013
1 parent 2e643f4
commit b15ea5e
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/src/main/java/com/turn/ttorrent/client/Client.java b/src/main/java/com/turn/ttorrent/client/Client.java
@@ -172,10 +172,22 @@ public Client(InetAddress address, SharedTorrent torrent)
 		this.random = new Random(System.currentTimeMillis());
 	}
 
+	/**
+	 * Set the maximum download rate (in kb/second) for this 
+	 * torrent. A setting of <= 0.0 disables rate limiting.
+	 * 
+	 * @param rate The maximum download rate
+	 */
 	public void setMaxDownloadRate(double rate){
 		this.torrent.setMaxDownloadRate(rate);
 	}
 
+	/**
+	 * Set the maximum upload rate (in kb/second) for this 
+	 * torrent. A setting of <= 0.0 disables rate limiting.
+	 * 
+	 * @param rate The maximum upload rate
+	 */
 	public void setMaxUploadRate(double rate){
 		this.torrent.setMaxUploadRate(rate);
 	}

diff --git a/src/main/java/com/turn/ttorrent/client/SharedTorrent.java b/src/main/java/com/turn/ttorrent/client/SharedTorrent.java
@@ -253,6 +253,12 @@ public double getMaxUploadRate(){
 		return this.maxUploadRate;
 	}
 
+	/**
+	 * Set the maximum upload rate (in kb/second) for this 
+	 * torrent. A setting of <= 0.0 disables rate limiting.
+	 * 
+	 * @param rate The maximum upload rate
+	 */
 	public void setMaxUploadRate(double rate){
 		this.maxUploadRate = rate;
 	}
@@ -261,6 +267,12 @@ public double getMaxDownloadRate(){
 		return this.maxDownloadRate;
 	}
 
+	/**
+	 * Set the maximum download rate (in kb/second) for this 
+	 * torrent. A setting of <= 0.0 disables rate limiting.
+	 * 
+	 * @param rate The maximum download rate
+	 */
 	public void setMaxDownloadRate(double rate){
 		this.maxDownloadRate = rate;
 	}