Base: Improve docstrings in AxisPy.xml
This commit is contained in:
@@ -13,57 +13,56 @@
|
||||
FatherNamespace="Base">
|
||||
<Documentation>
|
||||
<Author Licence="LGPL" Name="Juergen Riegel" EMail="FreeCAD@juergen-riegel.net" />
|
||||
<UserDocu>Axis
|
||||
An defines a direction and a position (base) in 3D space.
|
||||
|
||||
The following constructors are supported:
|
||||
Axis() -- empty constructor
|
||||
Axis(Axis) -- copy constructor
|
||||
Axis(Base, Direction) -- define position and direction
|
||||
</UserDocu>
|
||||
<UserDocu>Base.Axis class.\n
|
||||
An Axis defines a direction and a position (base) in 3D space.\n
|
||||
The following constructors are supported:\n
|
||||
Axis()
|
||||
Empty constructor.\n
|
||||
Axis(axis)
|
||||
Copy constructor.
|
||||
axis : Base.Axis\n
|
||||
Axis(base, direction)
|
||||
Define from a position and a direction.
|
||||
base : Base.Vector
|
||||
direction : Base.Vector</UserDocu>
|
||||
<DeveloperDocu>Axis</DeveloperDocu>
|
||||
</Documentation>
|
||||
<Methode Name="copy">>
|
||||
<Documentation>
|
||||
<UserDocu>
|
||||
copy()
|
||||
Returns a copy of this Axis
|
||||
</UserDocu>
|
||||
<UserDocu>copy() -> Base.Axis\n
|
||||
Returns a copy of this Axis.</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="move">
|
||||
<Documentation>
|
||||
<UserDocu>
|
||||
move(Vector)
|
||||
Move the axis base along the vector
|
||||
</UserDocu>
|
||||
<UserDocu>move(vector) -> None\n
|
||||
Move the axis base along the given vector.\n
|
||||
vector : Base.Vector\n Vector by which to move the axis.</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="multiply">
|
||||
<Documentation>
|
||||
<UserDocu>
|
||||
multiply(Placement)
|
||||
Multiply this axis with a placement
|
||||
</UserDocu>
|
||||
<UserDocu>multiply(placement) -> Base.Axis\n
|
||||
Multiply this axis by a placement.\n
|
||||
placement : Base.Placement\n Placement by which to multiply the axis.</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Methode Name="reversed">
|
||||
<Documentation>
|
||||
<UserDocu>
|
||||
reversed() -> Axis
|
||||
compute the reversed axis
|
||||
</UserDocu>
|
||||
<UserDocu>reversed() -> Base.Axis\n
|
||||
Compute the reversed axis. This returns a new Base.Axis with
|
||||
the original direction reversed.</UserDocu>
|
||||
</Documentation>
|
||||
</Methode>
|
||||
<Attribute Name="Base" ReadOnly="false">
|
||||
<Documentation>
|
||||
<UserDocu>Vector to the Base position of the Axis</UserDocu>
|
||||
<UserDocu>Base position vector of the Axis.</UserDocu>
|
||||
</Documentation>
|
||||
<Parameter Name="Base" Type="Object" />
|
||||
</Attribute>
|
||||
<Attribute Name="Direction" ReadOnly="false">
|
||||
<Documentation>
|
||||
<UserDocu>Direction vector of the Axis</UserDocu>
|
||||
<UserDocu>Direction vector of the Axis.</UserDocu>
|
||||
</Documentation>
|
||||
<Parameter Name="Direction" Type="Object" />
|
||||
</Attribute>
|
||||
|
||||
Reference in New Issue
Block a user