From fd36956061b3400b0502348b8758e08c1755b8c6 Mon Sep 17 00:00:00 2001
From: Yorik van Havre <yorikvanhavre@users.sourceforge.net>
Date: Thu, 29 Mar 2012 11:17:04 -0300
Subject: [PATCH] Reformatted the VectorPy docstrings for better aspect in
 sphinx docs

---
 src/Base/VectorPy.xml | 73 ++++++++++++++++++++++++++++++++-----------
 1 file changed, 55 insertions(+), 18 deletions(-)

diff --git a/src/Base/VectorPy.xml b/src/Base/VectorPy.xml
index 4171ac2a1..6286e4b27 100644
--- a/src/Base/VectorPy.xml
+++ b/src/Base/VectorPy.xml
@@ -20,90 +20,127 @@
 	</Documentation>
 		<Methode Name="add" Const="true">
 			<Documentation>
-				<UserDocu>add(Vector) - return the sum of the two vectors</UserDocu>
+				<UserDocu>add(Vector)
+					      returns the sum of this and another vector
+				</UserDocu>
 			</Documentation>
 		</Methode>
 		<Methode Name="sub" Const="true">
 			<Documentation>
-				<UserDocu>sub(Vector) - return the difference of the two vectors</UserDocu>
+				<UserDocu>sub(Vector)
+					      returns the difference of this and another vector
+				</UserDocu>
 			</Documentation>
 		</Methode>
 		<Methode Name="scale">
 			<Documentation>
-				<UserDocu>scale(Float,Float,Float) - scale (multiplies) this vector by a factor</UserDocu>
+				<UserDocu>scale(Float,Float,Float)
+					      scales (multiplies) this vector by a factor
+			    </UserDocu>
 			</Documentation>
 		</Methode>
 		<Methode Name="multiply">
 			<Documentation>
-				<UserDocu>multiply(Float) - multiplies (scales) this vector by a single factor</UserDocu>
+				<UserDocu>multiply(Float)
+					      multiplies (scales) this vector by a single factor
+				</UserDocu>
 			</Documentation>
 		</Methode>
 		<Methode Name="dot" Const="true">
 			<Documentation>
-				<UserDocu>dot(Vector) - return the dot product of the two vectors</UserDocu>
+				<UserDocu>dot(Vector)
+						  returns the dot product of the this vector with another one
+				</UserDocu>
 			</Documentation>
 		</Methode>
 		<Methode Name="cross" Const="true">
 			<Documentation>
-				<UserDocu>cross(Vector) - return the cross product of the two vectors</UserDocu>
+				<UserDocu>cross(Vector)
+					      returns the cross product between this and another vector
+				</UserDocu>
 			</Documentation>
 		</Methode>
 		<Methode Name="getAngle" Const="true">
 			<Documentation>
-				<UserDocu>getAngle(Vector) - return the angle in radians between the two vectors</UserDocu>
+				<UserDocu>getAngle(Vector)
+					      returns the angle in radians between this and another vector
+				</UserDocu>
 			</Documentation>
 		</Methode>
 		<Methode Name="normalize">
 			<Documentation>
-				<UserDocu>Normalize the vector to the length of 1.0</UserDocu>
+				<UserDocu>normalize()
+						  normalizes the vector to the length of 1.0
+				</UserDocu>
 			</Documentation>
 		</Methode>
 		<Methode Name="projectToLine">
 			<Documentation>
-				<UserDocu>Deliver the projection point to a given line</UserDocu>
+				<UserDocu>projectToLine(Vector,Vector)
+						  projects the vector on a line defined by a base point and a direction
+				</UserDocu>
 			</Documentation>
 		</Methode>
 		<Methode Name="projectToPlane">
 			<Documentation>
-				<UserDocu>Deliver the projection point to a given plane</UserDocu>
+				<UserDocu>projectToPlane(Vector,Vector)
+						  projects the vector on a plane defined by a base point and a normal
+				</UserDocu>
 			</Documentation>
 		</Methode>
 		<Methode Name="distanceToLine" Const="true">
 			<Documentation>
-				<UserDocu>Deliver the distance of the point to a given line</UserDocu>
+				<UserDocu>distanceToLine(Vector,Vector)
+						  returns the distance between this vector and a line defined by
+						  a base point and a direction
+				</UserDocu>
 			</Documentation>
 		</Methode>
 		<Methode Name="distanceToLineSegment" Const="true">
 			<Documentation>
-				<UserDocu>Deliver the distance of the point to a given line segment</UserDocu>
+				<UserDocu>distanceToLineSegment(Vector,Vector)
+						  returns the distance between this vector and a line segment defined by
+						  a base point and a direction
+				</UserDocu>
 			</Documentation>
 		</Methode>
 		<Methode Name="distanceToPlane" Const="true">
 			<Documentation>
-				<UserDocu>Deliver the distance of the point to a given plane</UserDocu>
+				<UserDocu>distanceToPlane(Vector,Vector)
+						  returns the distance between this vector and a plane defined by
+						  a base point and a normal
+				</UserDocu>
 			</Documentation>
 		</Methode>
 		<Attribute Name="Length" ReadOnly="false">
 			<Documentation>
-				<UserDocu>To read or modifiy the length of the vector</UserDocu>
+				<UserDocu>Length([Float]) -> Float
+						  gets or sets the length of this vector
+				</UserDocu>
 			</Documentation>
 			<Parameter Name="Type" Type="Float" />
 		</Attribute>
 		<Attribute Name="x" ReadOnly="false">
 			<Documentation>
-				<UserDocu>The X component of the vector</UserDocu>
+				<UserDocu>x([Float]) -> Float
+						  gets or sets the X component of this vector
+				</UserDocu>
 			</Documentation>
 			<Parameter Name="x" Type="Float"/>
 		</Attribute>
 		<Attribute Name="y" ReadOnly="false">
 			<Documentation>
-				<UserDocu>The Y component of the vector</UserDocu>
+				<UserDocu>y([Float]) -> Float
+						  gets or sets the Y component of this vector
+				</UserDocu>
 			</Documentation>
 			<Parameter Name="y" Type="Float"/>
 		</Attribute>
 		<Attribute Name="z" ReadOnly="false">
 			<Documentation>
-				<UserDocu>The Z component of the vector</UserDocu>
+				<UserDocu>z([Float]) -> Float
+						  gets or sets the Z component of this vector
+				</UserDocu>
 			</Documentation>
 			<Parameter Name="z" Type="Float"/>
 		</Attribute>
@@ -128,4 +165,4 @@
     { return *(getVectorPtr()); }
 		</ClassDeclarations>
 	</PythonExport>
-</GenerateModel>
+</GenerateModel>