Browse Source

Added stubs for all core classes

Jeff Terrace 13 years ago
parent
commit
8672949265

+ 1 - 0
.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 *.swp
 .project
+doc/_build

+ 7 - 2
doc/api/core/Clock.rst

@@ -1,2 +1,7 @@
-Clock - something
------------------
+Clock - Keeps track of time
+---------------------------
+
+.. js:class:: Clock()
+
+    Keeps track of time
+    

+ 7 - 2
doc/api/core/Edge.rst

@@ -1,2 +1,7 @@
-Edge - something
-----------------
+Edge - Edge between two vertices
+--------------------------------
+
+.. js:class:: Edge()
+
+    Edge between two vertices
+    

+ 7 - 2
doc/api/core/Face3.rst

@@ -1,2 +1,7 @@
-Face3 - something
------------------
+Face3 - Three-sided face
+------------------------
+
+.. js:class:: Face3()
+
+    Three-sided face
+    

+ 7 - 2
doc/api/core/Face4.rst

@@ -1,2 +1,7 @@
-Face4 - something
------------------
+Face4 - Four-sided face
+-----------------------
+
+.. js:class:: Face4()
+
+    Four-sided face
+    

+ 7 - 2
doc/api/core/Geometry.rst

@@ -1,2 +1,7 @@
-Geometry - something
---------------------
+Geometry - Base class for geometry types
+----------------------------------------
+
+.. js:class:: Geometry()
+
+    Base class for geometry types
+    

+ 7 - 2
doc/api/core/Math.rst

@@ -1,2 +1,7 @@
-Math - something
-----------------
+Math - Math utility functions
+-----------------------------
+
+.. js:class:: Math()
+
+    Math utility functions
+    

+ 7 - 2
doc/api/core/Matrix3.rst

@@ -1,2 +1,7 @@
-Matrix3 - something
--------------------
+Matrix3 - A 3x3 matrix
+----------------------
+
+.. js:class:: Matrix3()
+
+    A 3x3 matrix
+    

+ 7 - 2
doc/api/core/Matrix4.rst

@@ -1,2 +1,7 @@
-Matrix4 - something
--------------------
+Matrix4 - A 4x4 Matrix
+----------------------
+
+.. js:class:: Matrix4()
+
+    A 4x4 Matrix
+    

+ 7 - 2
doc/api/core/Object3D.rst

@@ -1,2 +1,7 @@
-Object3D - something
---------------------
+Object3D - Base class for scene graph objects
+---------------------------------------------
+
+.. js:class:: Object3D()
+
+    Base class for scene graph objects
+    

+ 7 - 2
doc/api/core/Projector.rst

@@ -1,2 +1,7 @@
-Projector - something
----------------------
+Projector - Utilities for projecting primitives between spaces
+--------------------------------------------------------------
+
+.. js:class:: Projector()
+
+    Utilities for projecting primitives between spaces
+    

+ 7 - 2
doc/api/core/Quaternion.rst

@@ -1,2 +1,7 @@
-Quaternion - something
-----------------------
+Quaternion - Implementation of a quaternion
+-------------------------------------------
+
+.. js:class:: Quaternion()
+
+    Implementation of a quaternion
+    

+ 7 - 2
doc/api/core/Ray.rst

@@ -1,2 +1,7 @@
-Ray - something
----------------
+Ray - Representation of a ray in space
+--------------------------------------
+
+.. js:class:: Ray()
+
+    Representation of a ray in space
+    

+ 7 - 2
doc/api/core/Rectangle.rst

@@ -1,2 +1,7 @@
-Rectangle - something
----------------------
+Rectangle - Represents a 2D rectangle
+-------------------------------------
+
+.. js:class:: Rectangle()
+
+    Represents a 2D rectangle
+    

+ 7 - 2
doc/api/core/Spline.rst

@@ -1,2 +1,7 @@
-Spline - something
-------------------
+Spline - Represents a spline
+----------------------------
+
+.. js:class:: Spline()
+
+    Represents a spline
+    

+ 7 - 2
doc/api/core/UV.rst

@@ -1,2 +1,7 @@
-UV - something
---------------
+UV - Represents a texture coordinate
+------------------------------------
+
+.. js:class:: UV()
+
+    Represents a texture coordinate
+    

+ 6 - 1
doc/api/core/Vector2.rst

@@ -1,2 +1,7 @@
-Vector2 - something
+Vector2 - 2D vector
 -------------------
+
+.. js:class:: Vector2()
+
+    2D vector
+    

+ 6 - 1
doc/api/core/Vector3.rst

@@ -1,2 +1,7 @@
-Vector3 - something
+Vector3 - 3D vector
 -------------------
+
+.. js:class:: Vector3()
+
+    3D vector
+    

+ 6 - 1
doc/api/core/Vector4.rst

@@ -1,2 +1,7 @@
-Vector4 - something
+Vector4 - 4D vector
 -------------------
+
+.. js:class:: Vector4()
+
+    4D vector
+    

+ 7 - 2
doc/api/core/Vertex.rst

@@ -1,2 +1,7 @@
-Vertex - something
-------------------
+Vertex - Represents a vertex in space
+-------------------------------------
+
+.. js:class:: Vertex()
+
+    Represents a vertex in space
+