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

@@ -10,6 +10,8 @@ from App.Part import Part
)
class AssemblyLink(Part):
"""
Author: Ondsel (development@ondsel.com)
License: LGPL-2.1-or-later
This class handles document objects in Assembly
"""

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 (development@ondsel.com)
License: LGPL-2.1-or-later
This class handles document objects in Assembly
"""

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 (development@ondsel.com)
License: LGPL-2.1-or-later
This class is a group subclass for boms.
"""

View File

@@ -8,5 +8,7 @@ from Spreadsheet.Sheet import Sheet
)
class BomObject(Sheet):
"""
Author: Ondsel (development@ondsel.com)
License: LGPL-2.1-or-later
This class is the BOM object of assemblies, it derives from Spreadsheet::Sheet.
"""

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 (development@ondsel.com)
License: LGPL-2.1-or-later
This class is a group subclass for joints.
"""

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 (development@ondsel.com)
License: LGPL-2.1-or-later
This class is a group subclass for joints.
"""

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 (development@ondsel.com)
License: LGPL-2.1-or-later
This class is a group subclass for joints.
"""

View File

@@ -7,6 +7,8 @@ from Gui.ViewProvider import ViewProvider
@export(Include="Mod/Assembly/Gui/ViewProviderAssembly.h", Namespace="AssemblyGui")
class ViewProviderAssembly(ViewProvider):
"""
Author: Ondsel (development@ondsel.com)
License: LGPL-2.1-or-later
This is the ViewProviderAssembly class
"""

View File

@@ -11,6 +11,8 @@ from Base.Metadata import export
)
class Area(BaseClass):
"""
Author: Zheng, Lei (realthunder.dev@gmail.com)
License: LGPL-2.1-or-later
FreeCAD python wrapper of libarea
Path.Area(key=value ...)

View File

@@ -10,6 +10,8 @@ from App.DocumentObject import DocumentObject
)
class FeatureArea(DocumentObject):
"""
Author: Zheng, Lei (realthunder.dev@gmail.com)
License: LGPL-2.1-or-later
This class handles Path Area features
"""

View File

@@ -11,6 +11,8 @@ from App.DocumentObject import DocumentObject
)
class FeaturePathCompound(DocumentObject):
"""
Author: Yorik van Havre (yorik@uncreated.net)
License: LGPL-2.1-or-later
This class handles Path Compound features
"""

View File

@@ -13,6 +13,8 @@ from Base.Persistence import Persistence
)
class Path(Persistence):
"""
Author: Yorik van Havre (yorik@uncreated.net)
License: LGPL-2.1-or-later
Path([commands]): Represents a basic Gcode path
commands (optional) is a list of Path commands
"""

View File

@@ -11,6 +11,8 @@ from Base.Metadata import constmethod, export
)
class Voronoi(BaseClass):
"""
Author: sliptonic (shopinthewoods@gmail.com)
License: LGPL-2.1-or-later
Voronoi([segments]): Create voronoi for given collection of line segments
"""

View File

@@ -12,6 +12,8 @@ from Base.Metadata import constmethod, export
)
class VoronoiCell(BaseClass):
"""
Author: sliptonic (shopinthewoods@gmail.com)
License: LGPL-2.1-or-later
Cell of a Voronoi diagram
"""

View File

@@ -12,6 +12,8 @@ from Base.Metadata import constmethod, export
)
class VoronoiEdge(BaseClass):
"""
Author: sliptonic (shopinthewoods@gmail.com)
License: LGPL-2.1-or-later
Edge of a Voronoi diagram
"""

View File

@@ -12,6 +12,8 @@ from Base.Metadata import constmethod, export
)
class VoronoiVertex(BaseClass):
"""
Author: sliptonic (shopinthewoods@gmail.com)
License: LGPL-2.1-or-later
Vertex of a Voronoi diagram
"""

View File

@@ -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():

View File

@@ -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():

View File

@@ -13,6 +13,8 @@ from App.ComplexGeoData import ComplexGeoData
)
class FemMesh(ComplexGeoData):
"""
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
FemMesh class
"""

View File

@@ -12,6 +12,8 @@ from Fem.FemPostFilter import FemPostFilter
)
class FemPostBranchFilter(FemPostFilter):
"""
Author: Stefan Tröger (stefantroeger@gmx.net)
License: LGPL-2.1-or-later
The FemPostBranch class.
"""

View File

@@ -12,6 +12,8 @@ from Fem.FemPostObject import FemPostObject
)
class FemPostFilter(FemPostObject):
"""
Author: Stefan Tröger (stefantroeger@gmx.net)
License: LGPL-2.1-or-later
The FemPostFilter class.
"""

View File

@@ -12,6 +12,8 @@ from App.GeoFeature import GeoFeature
)
class FemPostObject(GeoFeature):
"""
Author: Mario Passaglia (mpassaglia@cbc.uba.ar)
License: LGPL-2.1-or-later
The FemPostObject class.
"""

View File

@@ -12,6 +12,8 @@ from Fem.FemPostObject import FemPostObject
)
class FemPostPipeline(FemPostObject):
"""
Author: Stefan Tröger (stefantroeger@gmx.net)
License: LGPL-2.1-or-later
The FemPostPipeline class.
"""

View File

@@ -10,6 +10,8 @@ from Gui.ViewProviderGeometryObject import ViewProviderGeometryObject
)
class ViewProviderFemConstraint(ViewProviderGeometryObject):
"""
Author: Mario Passaglia (mpassaglia@cbc.uba.ar)
License: LGPL-2.1-or-later
This is the ViewProviderFemConstraint class
"""

View File

@@ -10,6 +10,8 @@ from Gui.ViewProviderGeometryObject import ViewProviderGeometryObject
)
class ViewProviderFemMesh(ViewProviderGeometryObject):
"""
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
ViewProviderFemMesh class
"""

View File

@@ -13,6 +13,8 @@ from Gui.ViewProviderDocumentObject import ViewProviderDocumentObject
)
class ViewProviderFemPostFilter(ViewProviderDocumentObject):
"""
Author: Stefan Tröger (stefantroeger@gmx.net)
License: LGPL-2.1-or-later
ViewProviderFemPostPipeline class
"""

View File

@@ -10,6 +10,8 @@ from Gui.ViewProviderDocumentObject import ViewProviderDocumentObject
)
class ViewProviderFemPostPipeline(ViewProviderDocumentObject):
"""
Author: Uwe Stöhr (uwestoehr@lyx.org)
License: LGPL-2.1-or-later
ViewProviderFemPostPipeline class
"""

View File

@@ -11,6 +11,8 @@ from Base.PyObjectBase import PyObjectBase
)
class StepShape(PyObjectBase):
"""
Author: Juergen Riegel (Juergen.Riegel@web.de)
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.
"""

View File

@@ -9,5 +9,7 @@ from App.DocumentObject import DocumentObject
)
class MeasureBase(DocumentObject):
"""
Author: David Friedli(hlorus) (david@friedli-be.ch)
License: LGPL-2.1-or-later
User documentation here
"""

View File

@@ -10,6 +10,8 @@ from Base.Metadata import export
)
class Measurement(BaseClass):
"""
Author: Luke Parry (l.parry@warwick.ac.uk)
License: LGPL-2.1-or-later
Make a measurement
"""

View File

@@ -9,5 +9,7 @@ from Base.PyObjectBase import PyObjectBase
)
class QuickMeasure(PyObjectBase):
"""
Author: Ondsel (development@ondsel.com)
License: LGPL-2.1-or-later
Selection Observer for the QuickMeasure label.
"""

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
"""

View File

@@ -15,6 +15,8 @@ from Data import object
)
class Points(object):
"""
Author: Juergen Riegel (Juergen.Riegel@web.de)
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,

View File

@@ -11,6 +11,8 @@ from Base.Persistence import Persistence
)
class Robot6Axis(Persistence):
"""
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
Robot6Axis class
"""

View File

@@ -10,6 +10,8 @@ from App.DocumentObject import DocumentObject
)
class RobotObject(DocumentObject):
"""
Author: Juergen Riegel (FreeCAD@juergen-riegel.net)
License: LGPL-2.1-or-later
Robot document object
"""

View File

@@ -11,6 +11,8 @@ from Base.Persistence import Persistence
)
class Trajectory(Persistence):
"""
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
Trajectory class
"""

View File

@@ -11,6 +11,8 @@ from Base.Persistence import Persistence
)
class Waypoint(Persistence):
"""
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
Waypoint class
"""

View File

@@ -8,5 +8,7 @@ from Base.Persistence import Persistence
)
class PropertyColumnWidths(Persistence):
"""
Author: Eivind Kvedalen (eivind@kvedalen.name)
License: LGPL-2.1-or-later
Internal spreadsheet object
"""

View File

@@ -8,5 +8,7 @@ from Base.Persistence import Persistence
)
class PropertyRowHeights(Persistence):
"""
Author: Eivind Kvedalen (eivind@kvedalen.name)
License: LGPL-2.1-or-later
Internal spreadsheet object
"""

View File

@@ -11,5 +11,7 @@ from Base.Persistence import Persistence
)
class PropertySheet(Persistence):
"""
Author: Eivind Kvedalen (eivind@kvedalen.name)
License: LGPL-2.1-or-later
Internal spreadsheet object
"""

View File

@@ -11,6 +11,8 @@ from App.DocumentObject import DocumentObject
)
class Sheet(DocumentObject):
"""
Author: Eivind Kvedalen (eivind@kvedalen.name)
License: LGPL-2.1-or-later
With this object you can manipulate spreadsheets
"""

View File

@@ -12,6 +12,8 @@ from Gui.ViewProviderDocumentObject import ViewProviderDocumentObject
)
class ViewProviderSpreadsheet(ViewProviderDocumentObject):
"""
Author: Jose Luis Cercos Pita (jlcercos@gmail.com)
License: LGPL-2.1-or-later
ViewProviderSheet class
"""

View File

@@ -11,6 +11,8 @@ from Base.Metadata import export
)
class BlendCurve(PyObjectBase):
"""
Author: Mattéo Grellier (matteogrellier@gmail.com)
License: LGPL-2.1-or-later
Create a BlendCurve that interpolate 2 BlendPoints.
curve = BlendCurve(BlendPoint1, BlendPoint2)
"""

View File

@@ -11,6 +11,8 @@ from Base.Metadata import constmethod, export
)
class BlendPoint(PyObjectBase):
"""
Author: Mattéo Grellier (matteogrellier@gmail.com)
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

View File

@@ -11,6 +11,8 @@ from Base.Metadata import constmethod, export
)
class CenterLine(PyObjectBase):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
CenterLine specifies additional mark up edges in a View
"""

View File

@@ -12,6 +12,8 @@ from Base.Metadata import export
)
class CosmeticEdge(PyObjectBase):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
CosmeticEdge specifies an extra (cosmetic) edge in Views
"""

View File

@@ -8,5 +8,7 @@ from App.DocumentObjectExtension import DocumentObjectExtension
)
class CosmeticExtension(DocumentObjectExtension):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
This object represents cosmetic features for a DrawViewPart.
"""

View File

@@ -11,6 +11,8 @@ from Base.Metadata import constmethod, export
)
class CosmeticVertex(PyObjectBase):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
CosmeticVertex specifies an extra (cosmetic) vertex in Views
"""

View File

@@ -10,6 +10,8 @@ from TechDraw.DrawViewPart import DrawViewPart
)
class DrawBrokenView(DrawViewPart):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing broken views
"""

View File

@@ -9,6 +9,8 @@ from App.DocumentObject import DocumentObject
)
class DrawGeomHatch(DocumentObject):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing GeomHatch areas
"""

View File

@@ -8,6 +8,8 @@ from App.DocumentObject import DocumentObject
)
class DrawHatch(DocumentObject):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Hatch areas
"""

View File

@@ -8,5 +8,7 @@ from DrawView import DrawView
)
class DrawLeaderLine(DrawView):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for adding leaders to Technical Drawings
"""

View File

@@ -9,6 +9,8 @@ from App.DocumentObject import DocumentObject
)
class DrawPage(DocumentObject):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Pages
"""

View File

@@ -10,6 +10,8 @@ from DrawTemplate import DrawTemplate
)
class DrawParametricTemplate(DrawTemplate):
"""
Author: Luke Parry (l.parry@warwick.ac.uk)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Templates
"""

View File

@@ -10,6 +10,8 @@ from TechDraw.DrawViewCollection import DrawViewCollection
)
class DrawProjGroup(DrawViewCollection):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Projection Groups
"""

View File

@@ -10,6 +10,8 @@ from TechDraw.DrawViewPart import DrawViewPart
)
class DrawProjGroupItem(DrawViewPart):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for creating and manipulating component Views Technical Drawing Projection Groups
"""

View File

@@ -8,5 +8,7 @@ from TechDraw.DrawView import DrawView
)
class DrawRichAnno(DrawView):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for adding rich annotation blocks to Technical Drawings
"""

View File

@@ -10,6 +10,8 @@ from DrawTemplate import DrawTemplate
)
class DrawSVGTemplate(DrawTemplate):
"""
Author: Luke Parry (l.parry@warwick.ac.uk)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing SVG Templates
"""

View File

@@ -8,5 +8,7 @@ from App.DocumentObject import DocumentObject
)
class DrawTemplate(DocumentObject):
"""
Author: Luke Parry (l.parry@warwick.ac.uk)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Templates
"""

View File

@@ -8,5 +8,7 @@ from App.DocumentObject import DocumentObject
)
class DrawTile(DocumentObject):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for adding tiles to leader lines
"""

View File

@@ -8,5 +8,7 @@ from TechDraw.DrawTile import DrawTile
)
class DrawTileWeld(DrawTile):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for adding welding tiles to leader lines
"""

View File

@@ -10,6 +10,8 @@ from App.DocumentObject import DocumentObject
)
class DrawView(DocumentObject):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Views
"""

View File

@@ -8,5 +8,7 @@ from TechDraw.Drawview import DrawView
)
class DrawViewAnnotation(DrawView):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Annotation Views
"""

View File

@@ -10,6 +10,8 @@ from TechDraw.DrawView import DrawView
)
class DrawViewClip(DrawView):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Clip Views
"""

View File

@@ -10,6 +10,8 @@ from TechDraw.DrawView import DrawView
)
class DrawViewCollection(DrawView):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing View Collections
"""

View File

@@ -10,6 +10,8 @@ from TechDraw.DrawViewDimension import DrawViewDimension
)
class DrawViewDimExtent(DrawViewDimension):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing DimExtents
"""

View File

@@ -10,6 +10,8 @@ from TechDraw.DrawView import DrawView
)
class DrawViewDimension(DrawView):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Dimensions
"""

View File

@@ -10,6 +10,8 @@ from TechDraw.rawView import DrawView
)
class DrawViewPart(DrawView):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for creating and manipulating Technical Drawing Part Views
"""

View File

@@ -10,6 +10,8 @@ from TechDraw.DrawView import DrawView
)
class DrawViewSymbol(DrawView):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for creating and manipulating Drawing SVG Symbol Views
"""

View File

@@ -8,5 +8,7 @@ from TechDraw.DrawView import DrawView
)
class DrawWeldSymbol(DrawView):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
Feature for adding welding tiles to leader lines
"""

View File

@@ -11,6 +11,8 @@ from Base.Metadata import constmethod, export
)
class GeomFormat(PyObjectBase):
"""
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
GeomFormat specifies appearance parameters for TechDraw Geometry objects
"""