Przeglądaj źródła

Minor improvements to LineCurve3 doc

looeee 8 lat temu
rodzic
commit
7737c1885b

+ 7 - 0
docs/api/extras/curves/LineCurve.html

@@ -27,6 +27,13 @@
 		<h2>Properties</h2>
 		<div>See the base [page:Curve] class for common properties.</div>
 
+		<h3>[property:Boolean isLineCurve]</h3>
+		<div>
+			Used to check whether this or derived classes are LineCurves. Default is *true*.<br /><br />
+
+			You should not change this, as it used internally for optimisation.
+		</div>
+
 		<h3>[property:Vector2 v1]</h3>
 		<div>The start point.</div>
 

+ 8 - 6
docs/api/extras/curves/LineCurve3.html

@@ -12,27 +12,29 @@
 
 		<h1>[name]</h1>
 
-		<div class="desc">A curve representing a 3d line segment</div>
+		<div class="desc">A curve representing a 3d line segment.</div>
 
 		<h2>Constructor</h2>
 
 
 		<h3>[name]( [page:Vector3 v1], [page:Vector3 v2] )</h3>
 		<div>
-			v1 – The start point<br/>
-			v2 - The end point
+			[page:Vector3 v1] – The start point.<br/>
+			[page:Vector3 v2] - The end point.
 		</div>
 
 
 		<h2>Properties</h2>
+		<div>See the base [page:Curve] class for common properties.</div>
 
 		<h3>[property:Vector3 v1]</h3>
-		<h3>[property:Vector3 v2]</h3>
+		<div>The start point.</div>
 
+		<h3>[property:Vector3 v2]</h3>
+		<div>The end point.</div>
 
 		<h2>Methods</h2>
-
-		<h3>See [page:Curve] for inherited methods</h3>
+		<div>See the base [page:Curve] class for common methods.</div>
 
 		<h2>Source</h2>