[freenet-cvs] r13905 - trunk/freenet/src/freenet/support

[sb...@freenetproject.org]

Author: sback
Date: 2007-07-03 21:38:24 +0000 (Tue, 03 Jul 2007)
New Revision: 13905

Modified:
   trunk/freenet/src/freenet/support/TimeUtil.java
Log:
Some comments added to increase class readability

Modified: trunk/freenet/src/freenet/support/TimeUtil.java
===================================================================
--- trunk/freenet/src/freenet/support/TimeUtil.java     2007-07-03 15:41:25 UTC 
(rev 13904)
+++ trunk/freenet/src/freenet/support/TimeUtil.java     2007-07-03 21:38:24 UTC 
(rev 13905)
@@ -25,6 +25,17 @@
  * Formats milliseconds into a week/day/hour/second/milliseconds string.
  */
 public class TimeUtil {
+       
+       /**
+        * It converts a given time interval into a 
+        * week/day/hour/second.milliseconds string.
+        * @param timeInterval interval to convert
+        * @param maxTerms the terms number to display
+        * (e.g. 2 means "h" and "m" if the time could be expressed in hour,
+        * 3 means "h","m","s" in the same example)
+        * @param withSecondFractions if true it displays seconds.milliseconds
+        * @return the formatted String
+        */
     public static String formatTime(long timeInterval, int maxTerms, boolean 
withSecondFractions) {
         StringBuffer sb = new StringBuffer(64);
         long l = timeInterval;