Adding license documentation to interface class docblocks.

This commit is contained in:
Ian 'z0r0' Abreu
2025-09-01 21:50:59 -04:00
parent 0af34eeff6
commit b0b9f8fc35
76 changed files with 154 additions and 1 deletions

View File

@@ -11,6 +11,8 @@ from Base.PyObjectBase import PyObjectBase
)
class Edge(PyObjectBase):
"""
Author: Werner Mayer (wmayer[at]users.sourceforge.net)
License: LGPL-2.1-or-later
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).

View File

@@ -11,6 +11,8 @@ from Base.PyObjectBase import PyObjectBase
)
class Facet(PyObjectBase):
"""
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
Facet in mesh
This is a facet in a MeshObject. You can get it by e.g. iterating a
mesh. The facet has a connection to its mesh and allows therefore

View File

@@ -20,7 +20,10 @@ from App.ComplexGeoData import ComplexGeoData
class PropertyMeshKernel* parentProperty = nullptr;"""
)
class Mesh(ComplexGeoData):
"""Mesh() -- Create an empty mesh object.
"""
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
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.

View File

@@ -13,6 +13,8 @@ from App.GeoFeature import GeoFeature
)
class MeshFeature(GeoFeature):
"""
Author: Werner Mayer (wmayer@users.sourceforge.net)
License: LGPL-2.1-or-later
The Mesh::Feature class handles meshes.
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

View File

@@ -11,6 +11,8 @@ from Base.PyObjectBase import PyObjectBase
)
class MeshPoint(PyObjectBase):
"""
Author: Juergen Riegel (FreeCAD@juergen-riegel.net)
License: LGPL-2.1-or-later
Point in mesh
This is a point in a MeshObject. You can get it by e.g. iterating a
mesh. The point has a connection to its mesh and allows therefore

View File

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