ForkMaster/geom
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/geom.git synced 2025-01-25 01:20:36 +05:00
Code Issues Packages Projects Releases Wiki Activity

fix some warnings at doc generation

Browse Source
This commit is contained in:
eap 2013-06-17 12:42:48 +00:00
parent 7d03d7203b
commit 1fc45b2209
2 changed files with 19 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
src/GEOM_SWIG/geomBuilder.py
View File

@ -139,7 +139,7 @@
## - Sub-shapes are automatically published as child items of the parent main shape in the study if main
## shape was also published before. Otherwise, sub-shapes are published as top-level objects.
## - Not that some functions of \ref geomBuilder.geomBuilder "geomBuilder" class do not have
## @theName parameter (and, thus, do not support automatic publication).
## \a theName parameter (and, thus, do not support automatic publication).
## For example, some transformation operations like
## \ref geomBuilder.geomBuilder.TranslateDXDYDZ() "TranslateDXDYDZ()".
## Refer to the documentation to check if some function has such possibility.
@ -9595,6 +9595,17 @@ class geomBuilder(object, GEOM._objref_GEOM_Gen):
pass
return aDict
def GetCreationInformation(self, theShape):
info = theShape.GetCreationInformation()
# operationName
opName = info.operationName
if not opName: opName = "no info available"
res = "Operation: " + opName
# parameters
for parVal in info.params:
res += " \n %s = %s" % ( parVal.name, parVal.value )
return res
## Get a point, situated at the centre of mass of theShape.
# @param theShape Shape to define centre of mass of.
# @param theName Object name; when specified, this parameter is used
@ -11415,10 +11426,8 @@ class geomBuilder(object, GEOM._objref_GEOM_Gen):
## Cut of lists of groups.
# New group is created. It will contain only entities
# which are present in groups listed in theGList1 but
# are not present in groups from theGList2.
# @param theGList1 is a list of GEOM groups to include elements of.
# @param theGList2 is a list of GEOM groups to exclude elements of.
# which are present in groups listed in theGList.
# @param theGList is a list of GEOM groups to include elements of.
# @param theName Object name; when specified, this parameter is used
# for result publication in the study. Otherwise, if automatic
# publication is switched on, default value is used for result name.
@ -11430,12 +11439,10 @@ class geomBuilder(object, GEOM._objref_GEOM_Gen):
"""
Cut of lists of groups.
New group is created. It will contain only entities
which are present in groups listed in theGList1 but
are not present in groups from theGList2.
which are present in groups listed in theGList.
Parameters:
theGList1 is a list of GEOM groups to include elements of.
theGList2 is a list of GEOM groups to exclude elements of.
theGList is a list of GEOM groups to include elements of.
theName Object name; when specified, this parameter is used
for result publication in the study. Otherwise, if automatic
publication is switched on, default value is used for result name.
@ -12220,18 +12227,6 @@ class geomBuilder(object, GEOM._objref_GEOM_Gen):
self._autoPublish(anObj, theName, "dividedCylinder")
return anObj
##
# @param thelPoints list of points
# @return New GEOM_Object, containing the created shape.
#
# @ref tui_creation_smoothingsurface "Example"
def MakeSmoothingSurface(self, thelPoints):
thelPoints, Parameters = ParseParameters(thelPoints)
anObj = self.AdvOp.MakeSmoothingSurface(thelPoints)
RaiseIfFailed("MakeSmoothingSurface", self.AdvOp)
if Parameters: anObj.SetParameters(Parameters)
return anObj
#@@ insert new functions before this line @@ do not remove this line @@#
# end of l4_advanced

6
src/GEOM_SWIG/gsketcher.py
View File

@ -60,7 +60,7 @@ class Sketcher3D:
# Coordinates are considered as absolute.
# If the first point of sketcher is not yet defined, the first point
# from the listCoords will become the first sketcher point.
# @param X1, Y1, Z1, X2, Y2, Z2, ... Coordinates of points
# @param listCoords X1, Y1, Z1, X2, Y2, Z2, ... Coordinates of points
def addPointsAbsolute (self, *listCoords):
"""
Add one or more points, sequentially connected with straight segments.
@ -91,7 +91,7 @@ class Sketcher3D:
# Coordinates are considered relative to the previous point.
# If the first point of sketcher is not yet defined, the
# origin (0, 0, 0) will become the first sketcher point.
# @param X1, Y1, Z1, X2, Y2, Z2, ... Coordinates of points
# @param listCoords X1, Y1, Z1, X2, Y2, Z2, ... Coordinates of points
def addPointsRelative (self, *listCoords):
"""
Add one or more points, sequentially connected with straight segments.
@ -187,7 +187,7 @@ class Sketcher3D:
# @param axes can be: "OXY", "OYZ" or "OXZ"
# @param angle angle in a plane, defined by the \a axes
# @param height height from the plane, defined by the \a axes
# @param radius distance to the coordinate system origin
# @param length distance to the coordinate system origin
def addPointRadiusAngleHRelative (self, length, angle, height, axes="OXY"):
"""
Add one straight segment, defined by two angles and length.