Adding license documentation to interface class docblocks.

This commit is contained in:
Ian 'z0r0' Abreu
2025-09-01 21:50:59 -04:00
parent 6fa1adf141
commit b24040ee52
76 changed files with 154 additions and 1 deletions
+2
View File
@@ -10,6 +10,8 @@ from App.Part import Part
)
class AssemblyLink(Part):
"""
Author: Ondsel ([email protected])
License: LGPL-2.1-or-later
This class handles document objects in Assembly
"""
+2
View File
@@ -7,6 +7,8 @@ from App.Part import Part
@export(Include="Mod/Assembly/App/AssemblyObject.h", Namespace="Assembly")
class AssemblyObject(Part):
"""
Author: Ondsel ([email protected])
License: LGPL-2.1-or-later
This class handles document objects in Assembly
"""
+2
View File
@@ -5,5 +5,7 @@ from App.DocumentObjectGroup import DocumentObjectGroup
@export(Include="Mod/Assembly/App/BomGroup.h", Namespace="Assembly")
class BomGroup(DocumentObjectGroup):
"""
Author: Ondsel ([email protected])
License: LGPL-2.1-or-later
This class is a group subclass for boms.
"""
+2
View File
@@ -8,5 +8,7 @@ from Spreadsheet.Sheet import Sheet
)
class BomObject(Sheet):
"""
Author: Ondsel ([email protected])
License: LGPL-2.1-or-later
This class is the BOM object of assemblies, it derives from Spreadsheet::Sheet.
"""
+2
View File
@@ -5,5 +5,7 @@ from App.DocumentObjectGroup import DocumentObjectGroup
@export(Include="Mod/Assembly/App/JointGroup.h", Namespace="Assembly")
class JointGroup(DocumentObjectGroup):
"""
Author: Ondsel ([email protected])
License: LGPL-2.1-or-later
This class is a group subclass for joints.
"""
+2
View File
@@ -5,5 +5,7 @@ from App.DocumentObjectGroup import DocumentObjectGroup
@export(Include="Mod/Assembly/App/SimulationGroup.h", Namespace="Assembly")
class SimulationGroup(DocumentObjectGroup):
"""
Author: Ondsel ([email protected])
License: LGPL-2.1-or-later
This class is a group subclass for joints.
"""
+2
View File
@@ -5,5 +5,7 @@ from App.DocumentObjectGroup import DocumentObjectGroup
@export(Include="Mod/Assembly/App/ViewGroup.h", Namespace="Assembly")
class ViewGroup(DocumentObjectGroup):
"""
Author: Ondsel ([email protected])
License: LGPL-2.1-or-later
This class is a group subclass for joints.
"""
@@ -7,6 +7,8 @@ from Gui.ViewProvider import ViewProvider
@export(Include="Mod/Assembly/Gui/ViewProviderAssembly.h", Namespace="AssemblyGui")
class ViewProviderAssembly(ViewProvider):
"""
Author: Ondsel ([email protected])
License: LGPL-2.1-or-later
This is the ViewProviderAssembly class
"""
+2
View File
@@ -11,6 +11,8 @@ from Base.Metadata import export
)
class Area(BaseClass):
"""
Author: Zheng, Lei ([email protected])
License: LGPL-2.1-or-later
FreeCAD python wrapper of libarea
Path.Area(key=value ...)
+2
View File
@@ -10,6 +10,8 @@ from App.DocumentObject import DocumentObject
)
class FeatureArea(DocumentObject):
"""
Author: Zheng, Lei ([email protected])
License: LGPL-2.1-or-later
This class handles Path Area features
"""
+2
View File
@@ -11,6 +11,8 @@ from App.DocumentObject import DocumentObject
)
class FeaturePathCompound(DocumentObject):
"""
Author: Yorik van Havre ([email protected])
License: LGPL-2.1-or-later
This class handles Path Compound features
"""
+2
View File
@@ -13,6 +13,8 @@ from Base.Persistence import Persistence
)
class Path(Persistence):
"""
Author: Yorik van Havre ([email protected])
License: LGPL-2.1-or-later
Path([commands]): Represents a basic Gcode path
commands (optional) is a list of Path commands
"""
+2
View File
@@ -11,6 +11,8 @@ from Base.Metadata import constmethod, export
)
class Voronoi(BaseClass):
"""
Author: sliptonic ([email protected])
License: LGPL-2.1-or-later
Voronoi([segments]): Create voronoi for given collection of line segments
"""
+2
View File
@@ -12,6 +12,8 @@ from Base.Metadata import constmethod, export
)
class VoronoiCell(BaseClass):
"""
Author: sliptonic ([email protected])
License: LGPL-2.1-or-later
Cell of a Voronoi diagram
"""
+2
View File
@@ -12,6 +12,8 @@ from Base.Metadata import constmethod, export
)
class VoronoiEdge(BaseClass):
"""
Author: sliptonic ([email protected])
License: LGPL-2.1-or-later
Edge of a Voronoi diagram
"""
+2
View File
@@ -12,6 +12,8 @@ from Base.Metadata import constmethod, export
)
class VoronoiVertex(BaseClass):
"""
Author: sliptonic ([email protected])
License: LGPL-2.1-or-later
Vertex of a Voronoi diagram
"""
@@ -12,6 +12,8 @@ from Base.Metadata import export
)
class PathSim(BaseClass):
"""
Author: Shai Seger (shaise_at_g-mail)
License: LGPL-2.1-or-later
FreeCAD python wrapper of PathSimulator
PathSimulator.PathSim():
@@ -13,6 +13,8 @@ from Metadata import no_args
)
class CAMSim(BaseClass):
"""
Author: Shai Seger (shaise_at_g-mail)
License: LGPL-2.1-or-later
FreeCAD python wrapper of CAMSimulator
CAMSimulator.CAMSim():
+2
View File
@@ -13,6 +13,8 @@ from App.ComplexGeoData import ComplexGeoData
)
class FemMesh(ComplexGeoData):
"""
Author: Juergen Riegel ([email protected])
License: LGPL-2.1-or-later
FemMesh class
"""
+2
View File
@@ -12,6 +12,8 @@ from Fem.FemPostFilter import FemPostFilter
)
class FemPostBranchFilter(FemPostFilter):
"""
Author: Stefan Tröger ([email protected])
License: LGPL-2.1-or-later
The FemPostBranch class.
"""
+2
View File
@@ -12,6 +12,8 @@ from Fem.FemPostObject import FemPostObject
)
class FemPostFilter(FemPostObject):
"""
Author: Stefan Tröger ([email protected])
License: LGPL-2.1-or-later
The FemPostFilter class.
"""
+2
View File
@@ -12,6 +12,8 @@ from App.GeoFeature import GeoFeature
)
class FemPostObject(GeoFeature):
"""
Author: Mario Passaglia ([email protected])
License: LGPL-2.1-or-later
The FemPostObject class.
"""
+2
View File
@@ -12,6 +12,8 @@ from Fem.FemPostObject import FemPostObject
)
class FemPostPipeline(FemPostObject):
"""
Author: Stefan Tröger ([email protected])
License: LGPL-2.1-or-later
The FemPostPipeline class.
"""
@@ -10,6 +10,8 @@ from Gui.ViewProviderGeometryObject import ViewProviderGeometryObject
)
class ViewProviderFemConstraint(ViewProviderGeometryObject):
"""
Author: Mario Passaglia ([email protected])
License: LGPL-2.1-or-later
This is the ViewProviderFemConstraint class
"""
+2
View File
@@ -10,6 +10,8 @@ from Gui.ViewProviderGeometryObject import ViewProviderGeometryObject
)
class ViewProviderFemMesh(ViewProviderGeometryObject):
"""
Author: Juergen Riegel ([email protected])
License: LGPL-2.1-or-later
ViewProviderFemMesh class
"""
@@ -13,6 +13,8 @@ from Gui.ViewProviderDocumentObject import ViewProviderDocumentObject
)
class ViewProviderFemPostFilter(ViewProviderDocumentObject):
"""
Author: Stefan Tröger ([email protected])
License: LGPL-2.1-or-later
ViewProviderFemPostPipeline class
"""
@@ -10,6 +10,8 @@ from Gui.ViewProviderDocumentObject import ViewProviderDocumentObject
)
class ViewProviderFemPostPipeline(ViewProviderDocumentObject):
"""
Author: Uwe Stöhr ([email protected])
License: LGPL-2.1-or-later
ViewProviderFemPostPipeline class
"""
+2
View File
@@ -11,6 +11,8 @@ from Base.PyObjectBase import PyObjectBase
)
class StepShape(PyObjectBase):
"""
Author: Juergen Riegel ([email protected])
License: LGPL-2.1-or-later
StepShape in Import
This class gives a interface to retrieve TopoShapes out of an loaded STEP file of any kind.
"""
+2
View File
@@ -9,5 +9,7 @@ from App.DocumentObject import DocumentObject
)
class MeasureBase(DocumentObject):
"""
Author: David Friedli(hlorus) ([email protected])
License: LGPL-2.1-or-later
User documentation here
"""
+2
View File
@@ -10,6 +10,8 @@ from Base.Metadata import export
)
class Measurement(BaseClass):
"""
Author: Luke Parry ([email protected])
License: LGPL-2.1-or-later
Make a measurement
"""
+2
View File
@@ -9,5 +9,7 @@ from Base.PyObjectBase import PyObjectBase
)
class QuickMeasure(PyObjectBase):
"""
Author: Ondsel ([email protected])
License: LGPL-2.1-or-later
Selection Observer for the QuickMeasure label.
"""
+2
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).
+2
View File
@@ -11,6 +11,8 @@ from Base.PyObjectBase import PyObjectBase
)
class Facet(PyObjectBase):
"""
Author: Juergen Riegel ([email protected])
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
+4 -1
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 ([email protected])
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.
+2
View File
@@ -13,6 +13,8 @@ from App.GeoFeature import GeoFeature
)
class MeshFeature(GeoFeature):
"""
Author: Werner Mayer ([email protected])
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
+2
View File
@@ -11,6 +11,8 @@ from Base.PyObjectBase import PyObjectBase
)
class MeshPoint(PyObjectBase):
"""
Author: Juergen Riegel ([email protected])
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
+2
View File
@@ -8,6 +8,8 @@ from Base.Metadata import export
)
class ViewProviderMesh(ViewProviderGeometryObject):
"""
Author: Werner Mayer ([email protected])
License: LGPL-2.1-or-later
This is the ViewProvider base class
"""
+2
View File
@@ -15,6 +15,8 @@ from Data import object
)
class Points(object):
"""
Author: Juergen Riegel ([email protected])
License: LGPL-2.1-or-later
Points() -- Create an empty points object.
This class allows one to manipulate the Points object by adding new points, deleting facets, importing from an STL file,
+2
View File
@@ -11,6 +11,8 @@ from Base.Persistence import Persistence
)
class Robot6Axis(Persistence):
"""
Author: Juergen Riegel ([email protected])
License: LGPL-2.1-or-later
Robot6Axis class
"""
+2
View File
@@ -10,6 +10,8 @@ from App.DocumentObject import DocumentObject
)
class RobotObject(DocumentObject):
"""
Author: Juergen Riegel ([email protected])
License: LGPL-2.1-or-later
Robot document object
"""
+2
View File
@@ -11,6 +11,8 @@ from Base.Persistence import Persistence
)
class Trajectory(Persistence):
"""
Author: Juergen Riegel ([email protected])
License: LGPL-2.1-or-later
Trajectory class
"""
+2
View File
@@ -11,6 +11,8 @@ from Base.Persistence import Persistence
)
class Waypoint(Persistence):
"""
Author: Juergen Riegel ([email protected])
License: LGPL-2.1-or-later
Waypoint class
"""
@@ -8,5 +8,7 @@ from Base.Persistence import Persistence
)
class PropertyColumnWidths(Persistence):
"""
Author: Eivind Kvedalen ([email protected])
License: LGPL-2.1-or-later
Internal spreadsheet object
"""
@@ -8,5 +8,7 @@ from Base.Persistence import Persistence
)
class PropertyRowHeights(Persistence):
"""
Author: Eivind Kvedalen ([email protected])
License: LGPL-2.1-or-later
Internal spreadsheet object
"""
@@ -11,5 +11,7 @@ from Base.Persistence import Persistence
)
class PropertySheet(Persistence):
"""
Author: Eivind Kvedalen ([email protected])
License: LGPL-2.1-or-later
Internal spreadsheet object
"""
+2
View File
@@ -11,6 +11,8 @@ from App.DocumentObject import DocumentObject
)
class Sheet(DocumentObject):
"""
Author: Eivind Kvedalen ([email protected])
License: LGPL-2.1-or-later
With this object you can manipulate spreadsheets
"""
@@ -12,6 +12,8 @@ from Gui.ViewProviderDocumentObject import ViewProviderDocumentObject
)
class ViewProviderSpreadsheet(ViewProviderDocumentObject):
"""
Author: Jose Luis Cercos Pita ([email protected])
License: LGPL-2.1-or-later
ViewProviderSheet class
"""
@@ -11,6 +11,8 @@ from Base.Metadata import export
)
class BlendCurve(PyObjectBase):
"""
Author: Mattéo Grellier ([email protected])
License: LGPL-2.1-or-later
Create a BlendCurve that interpolate 2 BlendPoints.
curve = BlendCurve(BlendPoint1, BlendPoint2)
"""
@@ -11,6 +11,8 @@ from Base.Metadata import constmethod, export
)
class BlendPoint(PyObjectBase):
"""
Author: Mattéo Grellier ([email protected])
License: LGPL-2.1-or-later
Create BlendPoint from a point and some derivatives.
myBlendPoint = BlendPoint([Point, D1, D2, ..., DN])
BlendPoint can also be constructed from an edge
+2
View File
@@ -11,6 +11,8 @@ from Base.Metadata import constmethod, export
)
class CenterLine(PyObjectBase):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
CenterLine specifies additional mark up edges in a View
"""
+2
View File
@@ -12,6 +12,8 @@ from Base.Metadata import export
)
class CosmeticEdge(PyObjectBase):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
CosmeticEdge specifies an extra (cosmetic) edge in Views
"""
@@ -8,5 +8,7 @@ from App.DocumentObjectExtension import DocumentObjectExtension
)
class CosmeticExtension(DocumentObjectExtension):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
This object represents cosmetic features for a DrawViewPart.
"""
+2
View File
@@ -11,6 +11,8 @@ from Base.Metadata import constmethod, export
)
class CosmeticVertex(PyObjectBase):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
CosmeticVertex specifies an extra (cosmetic) vertex in Views
"""
+2
View File
@@ -10,6 +10,8 @@ from TechDraw.DrawViewPart import DrawViewPart
)
class DrawBrokenView(DrawViewPart):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing broken views
"""
+2
View File
@@ -9,6 +9,8 @@ from App.DocumentObject import DocumentObject
)
class DrawGeomHatch(DocumentObject):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing GeomHatch areas
"""
+2
View File
@@ -8,6 +8,8 @@ from App.DocumentObject import DocumentObject
)
class DrawHatch(DocumentObject):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Hatch areas
"""
+2
View File
@@ -8,5 +8,7 @@ from DrawView import DrawView
)
class DrawLeaderLine(DrawView):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for adding leaders to Technical Drawings
"""
+2
View File
@@ -9,6 +9,8 @@ from App.DocumentObject import DocumentObject
)
class DrawPage(DocumentObject):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Pages
"""
@@ -10,6 +10,8 @@ from DrawTemplate import DrawTemplate
)
class DrawParametricTemplate(DrawTemplate):
"""
Author: Luke Parry ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Templates
"""
+2
View File
@@ -10,6 +10,8 @@ from TechDraw.DrawViewCollection import DrawViewCollection
)
class DrawProjGroup(DrawViewCollection):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Projection Groups
"""
@@ -10,6 +10,8 @@ from TechDraw.DrawViewPart import DrawViewPart
)
class DrawProjGroupItem(DrawViewPart):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating component Views Technical Drawing Projection Groups
"""
+2
View File
@@ -8,5 +8,7 @@ from TechDraw.DrawView import DrawView
)
class DrawRichAnno(DrawView):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for adding rich annotation blocks to Technical Drawings
"""
+2
View File
@@ -10,6 +10,8 @@ from DrawTemplate import DrawTemplate
)
class DrawSVGTemplate(DrawTemplate):
"""
Author: Luke Parry ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing SVG Templates
"""
+2
View File
@@ -8,5 +8,7 @@ from App.DocumentObject import DocumentObject
)
class DrawTemplate(DocumentObject):
"""
Author: Luke Parry ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Templates
"""
+2
View File
@@ -8,5 +8,7 @@ from App.DocumentObject import DocumentObject
)
class DrawTile(DocumentObject):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for adding tiles to leader lines
"""
+2
View File
@@ -8,5 +8,7 @@ from TechDraw.DrawTile import DrawTile
)
class DrawTileWeld(DrawTile):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for adding welding tiles to leader lines
"""
+2
View File
@@ -10,6 +10,8 @@ from App.DocumentObject import DocumentObject
)
class DrawView(DocumentObject):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Views
"""
@@ -8,5 +8,7 @@ from TechDraw.Drawview import DrawView
)
class DrawViewAnnotation(DrawView):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Annotation Views
"""
+2
View File
@@ -10,6 +10,8 @@ from TechDraw.DrawView import DrawView
)
class DrawViewClip(DrawView):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Clip Views
"""
@@ -10,6 +10,8 @@ from TechDraw.DrawView import DrawView
)
class DrawViewCollection(DrawView):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing View Collections
"""
@@ -10,6 +10,8 @@ from TechDraw.DrawViewDimension import DrawViewDimension
)
class DrawViewDimExtent(DrawViewDimension):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing DimExtents
"""
@@ -10,6 +10,8 @@ from TechDraw.DrawView import DrawView
)
class DrawViewDimension(DrawView):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Dimensions
"""
+2
View File
@@ -10,6 +10,8 @@ from TechDraw.rawView import DrawView
)
class DrawViewPart(DrawView):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Part Views
"""
+2
View File
@@ -10,6 +10,8 @@ from TechDraw.DrawView import DrawView
)
class DrawViewSymbol(DrawView):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for creating and manipulating Drawing SVG Symbol Views
"""
+2
View File
@@ -8,5 +8,7 @@ from TechDraw.DrawView import DrawView
)
class DrawWeldSymbol(DrawView):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
Feature for adding welding tiles to leader lines
"""
+2
View File
@@ -11,6 +11,8 @@ from Base.Metadata import constmethod, export
)
class GeomFormat(PyObjectBase):
"""
Author: WandererFan ([email protected])
License: LGPL-2.1-or-later
GeomFormat specifies appearance parameters for TechDraw Geometry objects
"""