updating docblock locations.

This commit is contained in:
Ian 'z0r0' Abreu
2025-09-02 08:28:47 -04:00
parent 8d56e3e529
commit 0217c1ef97
76 changed files with 230 additions and 1 deletions

View File

@@ -14,6 +14,9 @@ class Edge(PyObjectBase):
Edge in mesh
This is an edge of a facet in a MeshObject. You can get it by e.g. iterating over the facets of a
mesh and calling getEdge(index).
Author: Werner Mayer (wmayer[at]users.sourceforge.net)
License: LGPL-2.1-or-later
"""
def intersectWithEdge(self) -> Any:

View File

@@ -17,6 +17,9 @@ class Facet(PyObjectBase):
topological operations. It is also possible to create an unbounded facet e.g. to create
a mesh. In this case the topological operations will fail. The same is
when you cut the bound to the mesh by calling unbound().
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
"""
def unbound(self) -> Any:

View File

@@ -20,7 +20,8 @@ from App.ComplexGeoData import ComplexGeoData
class PropertyMeshKernel* parentProperty = nullptr;"""
)
class Mesh(ComplexGeoData):
"""Mesh() -- Create an empty mesh object.
"""
Mesh() -- Create an empty mesh object.
This class allows one to manipulate the mesh object by adding new facets, deleting facets, importing from an STL file,
transforming the mesh and much more.
@@ -34,6 +35,9 @@ class Mesh(ComplexGeoData):
f = d.addObject("Mesh::Feature", "Mesh") # Create a mesh feature
f.Mesh = m # Assign the mesh object to the internal property
d.recompute()
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
"""
def read(self, **kwargs) -> Any:

View File

@@ -17,6 +17,9 @@ class MeshFeature(GeoFeature):
The Mesh.MeshFeature() function is for internal use only and cannot be used to create instances of this class.
Therefore you must have a reference to a document, e.g. 'd' then you can create an instance with
d.addObject("Mesh::Feature").
Author: Werner Mayer (wmayer@users.sourceforge.net)
License: LGPL-2.1-or-later
"""
def countPoints(self) -> Any:

View File

@@ -17,6 +17,9 @@ class MeshPoint(PyObjectBase):
topological operations. It is also possible to create an unbounded mesh point e.g. to create
a mesh. In this case the topological operations will fail. The same is
when you cut the bound to the mesh by calling unbound().
Author: Juergen Riegel (FreeCAD@juergen-riegel.net)
License: LGPL-2.1-or-later
"""
def unbound(self) -> Any:

View File

@@ -9,6 +9,9 @@ from Base.Metadata import export
class ViewProviderMesh(ViewProviderGeometryObject):
"""
This is the ViewProvider base class
Author: Werner Mayer (wmayer@users.sourceforge.net)
License: LGPL-2.1-or-later
"""
def setSelection(self) -> Any: