From 41afe9d8ae53c34939d434bb4347ec8d9b390740 Mon Sep 17 00:00:00 2001 From: marioalexis Date: Thu, 26 May 2022 13:26:42 -0300 Subject: [PATCH] Base: Improve docstrings in AxisPy.xml --- src/Base/AxisPy.xml | 51 ++++++++++++++++++++++----------------------- 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/src/Base/AxisPy.xml b/src/Base/AxisPy.xml index 5a520198db..ca9d60aa86 100644 --- a/src/Base/AxisPy.xml +++ b/src/Base/AxisPy.xml @@ -13,57 +13,56 @@ FatherNamespace="Base"> - 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 - + 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 Axis > - - copy() - Returns a copy of this Axis - + copy() -> Base.Axis\n +Returns a copy of this Axis. - - move(Vector) - Move the axis base along the vector - + move(vector) -> None\n +Move the axis base along the given vector.\n +vector : Base.Vector\n Vector by which to move the axis. - - multiply(Placement) - Multiply this axis with a placement - + multiply(placement) -> Base.Axis\n +Multiply this axis by a placement.\n +placement : Base.Placement\n Placement by which to multiply the axis. - - reversed() -> Axis - compute the reversed axis - + reversed() -> Base.Axis\n +Compute the reversed axis. This returns a new Base.Axis with +the original direction reversed. - Vector to the Base position of the Axis + Base position vector of the Axis. - Direction vector of the Axis + Direction vector of the Axis.