Browse Source

Documentation: Clock.

Mr.doob 13 years ago
parent
commit
5ac883160d
2 changed files with 31 additions and 61 deletions
  1. 31 6
      docs/api/core/Clock.html
  2. 0 55
      docs/api/core/Clock.rst

+ 31 - 6
docs/api/core/Clock.html

@@ -1,23 +1,48 @@
 <h1>[name]</h1>
 
-<div class="desc">todo</div>
+<div class="desc">Object for keeping track of time.</div>
 
 
 <h2>Constructor</h2>
 
-<h3>[name]()</h3>
-
+<h3>[name]( [page:Boolean autoStart] )</h3>
+<div>
+autoStart — Automatically start the clock.
+</div>
 
 <h2>Properties</h2>
 
-<h3>.[page:Vector3 todo]</h3>
+<h3>.[page:Boolean autoStart]</h3>
+
+<h3>.[page:Number startTime]</h3>
+
+<h3>.[page:Number oldTime]</h3>
+
+<h3>.[page:Number elapsedTime]</h3>
+
+<h3>.[page:Boolean running]</h3>
 
 
 <h2>Methods</h2>
 
-<h3>.todo( [page:Vector3 todo] )</h3>
+<h3>.start()</h3>
+<div>
+Start clock.
+</div>
+
+<h3>.stop()</h3>
+<div>
+Stop clock.
+</div>
+
+<h3>.getElapsedTime() [page:Number Number]</h3>
+<div>
+Get milliseconds passed since the clock started.
+</div>
+
+<h3>.getDelta() [page:Number Number]</h3>
 <div>
-todo — todo<br />
+Get the milliseconds passed since the last call to this method.
 </div>
 
 

+ 0 - 55
docs/api/core/Clock.rst

@@ -1,55 +0,0 @@
-Clock - Keeps track of time
----------------------------
-
-.. rubric:: Constructor
-
-.. class:: Clock(autoStart)
-
-//todo:description
-
-.. rubric:: Attributes
-
-.. attribute:: Clock.autoStart
-
-//todo:description
-
-.. attribute:: Clock.startTime
-
-//todo:description
-
-.. attribute:: Clock.oldTime
-
-//todo:description
-
-.. attribute:: Clock.elapsedTime
-
-//todo:description
-
-.. attribute:: Clock.running
-
-//todo:description
-
-.. rubric:: Methods
-
-.. function:: Clock.start()
-
-//todo:description
-
-.. function:: Clock.stop()
-
-//todo:description
-
-.. function:: Clock.getElapsedTime()
-
-//todo:description
-    :returns: //todo
-    :rtype: //todo
-
-.. function:: Clock.getDelta()
-
-//todo:description
-    :returns: //todo
-    :rtype: //todo
-
-.. rubric:: Example
-