Changeset 18412 in vbox for trunk/src

Timestamp:

Mar 27, 2009 4:12:31 PM (16 years ago)

Author:

vboxsync

Message:

Main: api docs

File:

• trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (1 diff)

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -7887 +7887 @@
     <attribute name="timeRemaining" type="long" readonly="yes">
         <desc>
-            Estimated remaining time until the operation completes, in
-            seconds.
-
-            Returns 0 if the task is complete.
-
-            Returns -1 if the time cannot be computed, in
-            particular if the current progress is 0.
-
-            The estimate will be unreliable for low progress
-            values. It will become more reliable as the task progresses;
-            it is not recommended to display an ETA before 10% of
-            a task have completed.
+            Estimated remaining time until the task completes, in
+            seconds. Returns 0 once the task has completed; returns -1
+            if the remaining time cannot be computed, in particular if
+            the current progress is 0.
+
+            Even if a value is returned, the estimate will be unreliable
+            for low progress values. It will become more reliable as the
+            task progresses; it is not recommended to display an ETA
+            before at least 20% of a task have completed.
         </desc>
     </attribute>