Author: scolebourne
Date: Tue Jun 7 14:28:07 2005
New Revision: 189443
URL: http://svn.apache.org/viewcvs?rev=189443&view=rev
Log:
Javadoc fix intended for 2.1 release
Modified:
jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/StopWatch.java
Modified:
jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/StopWatch.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/StopWatch.java?rev=189443&r1=189442&r2=189443&view=diff
==============================================================================
---
jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/StopWatch.java
(original)
+++
jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/StopWatch.java
Tue Jun 7 14:28:07 2005
@@ -18,10 +18,6 @@
/**
* <p><code>StopWatch</code> provides a convenient API for timings.</p>
*
- * <p>The methods do <b>not</b> protect against inappropriate calls. Thus you
- * can call stop before start, resume before suspend or unsplit before split.
- * The results are indeterminate in these cases.</p>
- *
* <p>To start the watch, call [EMAIL PROTECTED] #start()}. At this point you
can:</p>
* <ul>
* <li>[EMAIL PROTECTED] #split()} the watch to get the time whilst the watch
continues in the
@@ -36,12 +32,15 @@
* <p>It is intended that the output methods [EMAIL PROTECTED] #toString()}
and [EMAIL PROTECTED] #getTime()}
* should only be called after stop, split or suspend, however a suitable
result will
* be returned at other points.</p>
-
-1. split(), suspend(), or stop() cannot be invoked twice.
-2. unsplit() may only be called if the watch has been split()
-3. resume() may only be called if the watch has been suspend()
-4. start() cannot be called twice.
-
+ *
+ * <p>NOTE: As from v2.1, the methods protect against inappropriate calls.
+ * Thus you cannot now call stop before start, resume before suspend or
+ * unsplit before split.</p>
+ *
+ * <p>1. split(), suspend(), or stop() cannot be invoked twice<br />
+ * 2. unsplit() may only be called if the watch has been split()<br />
+ * 3. resume() may only be called if the watch has been suspend()<br />
+ * 4. start() cannot be called twice without calling reset()</p>
*
* @author Henri Yandell
* @author Stephen Colebourne
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
