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

@@ -11,6 +11,9 @@ from App.Part import Part
class AssemblyLink(Part):
"""
This class handles document objects in Assembly
Author: Ondsel (development@ondsel.com)
License: LGPL-2.1-or-later
"""
Joints: Final[list]

View File

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

View File

@@ -6,4 +6,7 @@ from App.DocumentObjectGroup import DocumentObjectGroup
class BomGroup(DocumentObjectGroup):
"""
This class is a group subclass for boms.
Author: Ondsel (development@ondsel.com)
License: LGPL-2.1-or-later
"""

View File

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

View File

@@ -6,4 +6,7 @@ from App.DocumentObjectGroup import DocumentObjectGroup
class JointGroup(DocumentObjectGroup):
"""
This class is a group subclass for joints.
Author: Ondsel (development@ondsel.com)
License: LGPL-2.1-or-later
"""

View File

@@ -6,4 +6,7 @@ from App.DocumentObjectGroup import DocumentObjectGroup
class SimulationGroup(DocumentObjectGroup):
"""
This class is a group subclass for joints.
Author: Ondsel (development@ondsel.com)
License: LGPL-2.1-or-later
"""

View File

@@ -6,4 +6,7 @@ from App.DocumentObjectGroup import DocumentObjectGroup
class ViewGroup(DocumentObjectGroup):
"""
This class is a group subclass for joints.
Author: Ondsel (development@ondsel.com)
License: LGPL-2.1-or-later
"""

View File

@@ -8,6 +8,9 @@ from Gui.ViewProvider import ViewProvider
class ViewProviderAssembly(ViewProvider):
"""
This is the ViewProviderAssembly class
Author: Ondsel (development@ondsel.com)
License: LGPL-2.1-or-later
"""
def isInEditMode(self) -> Any:

View File

@@ -17,6 +17,9 @@ class Area(BaseClass):
The constructor accepts the same parameters as setParams(...) to configure the object
All arguments are optional.
Author: Zheng, Lei (realthunder.dev@gmail.com)
License: LGPL-2.1-or-later
"""
def add(self, **kwargs) -> Any:

View File

@@ -11,6 +11,9 @@ from App.DocumentObject import DocumentObject
class FeatureArea(DocumentObject):
"""
This class handles Path Area features
Author: Zheng, Lei (realthunder.dev@gmail.com)
License: LGPL-2.1-or-later
"""
def getArea(self) -> Any:

View File

@@ -12,6 +12,9 @@ from App.DocumentObject import DocumentObject
class FeaturePathCompound(DocumentObject):
"""
This class handles Path Compound features
Author: Yorik van Havre (yorik@uncreated.net)
License: LGPL-2.1-or-later
"""
def addObject(self) -> Any:

View File

@@ -15,6 +15,9 @@ class Path(Persistence):
"""
Path([commands]): Represents a basic Gcode path
commands (optional) is a list of Path commands
Author: Yorik van Havre (yorik@uncreated.net)
License: LGPL-2.1-or-later
"""
def addCommands(self) -> Any:

View File

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

View File

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

View File

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

View File

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

View File

@@ -17,6 +17,9 @@ class PathSim(BaseClass):
PathSimulator.PathSim():
Create a path simulator object
Author: Shai Seger (shaise_at_g-mail)
License: LGPL-2.1-or-later
"""
def BeginSimulation(self, **kwargs) -> Any:

View File

@@ -18,6 +18,9 @@ class CAMSim(BaseClass):
CAMSimulator.CAMSim():
Create a path simulator object
Author: Shai Seger (shaise_at_g-mail)
License: LGPL-2.1-or-later
"""
def BeginSimulation(self, **kwargs) -> Any:

View File

@@ -14,6 +14,9 @@ from App.ComplexGeoData import ComplexGeoData
class FemMesh(ComplexGeoData):
"""
FemMesh class
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
"""
def setShape(self) -> Any:

View File

@@ -13,6 +13,9 @@ from Fem.FemPostFilter import FemPostFilter
class FemPostBranchFilter(FemPostFilter):
"""
The FemPostBranch class.
Author: Stefan Tröger (stefantroeger@gmx.net)
License: LGPL-2.1-or-later
"""
def getFilter(self) -> Any:

View File

@@ -13,6 +13,9 @@ from Fem.FemPostObject import FemPostObject
class FemPostFilter(FemPostObject):
"""
The FemPostFilter class.
Author: Stefan Tröger (stefantroeger@gmx.net)
License: LGPL-2.1-or-later
"""
def addFilterPipeline(self) -> Any:

View File

@@ -13,6 +13,9 @@ from App.GeoFeature import GeoFeature
class FemPostObject(GeoFeature):
"""
The FemPostObject class.
Author: Mario Passaglia (mpassaglia@cbc.uba.ar)
License: LGPL-2.1-or-later
"""
def writeVTK(self) -> Any:

View File

@@ -13,6 +13,9 @@ from Fem.FemPostObject import FemPostObject
class FemPostPipeline(FemPostObject):
"""
The FemPostPipeline class.
Author: Stefan Tröger (stefantroeger@gmx.net)
License: LGPL-2.1-or-later
"""
def read(self) -> Any:

View File

@@ -11,6 +11,9 @@ from Gui.ViewProviderGeometryObject import ViewProviderGeometryObject
class ViewProviderFemConstraint(ViewProviderGeometryObject):
"""
This is the ViewProviderFemConstraint class
Author: Mario Passaglia (mpassaglia@cbc.uba.ar)
License: LGPL-2.1-or-later
"""
def loadSymbol(self) -> Any:

View File

@@ -11,6 +11,9 @@ from Gui.ViewProviderGeometryObject import ViewProviderGeometryObject
class ViewProviderFemMesh(ViewProviderGeometryObject):
"""
ViewProviderFemMesh class
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
"""
def applyDisplacement(self) -> Any:

View File

@@ -14,6 +14,9 @@ from Gui.ViewProviderDocumentObject import ViewProviderDocumentObject
class ViewProviderFemPostFilter(ViewProviderDocumentObject):
"""
ViewProviderFemPostPipeline class
Author: Stefan Tröger (stefantroeger@gmx.net)
License: LGPL-2.1-or-later
"""
def createDisplayTaskWidget(self) -> Any:

View File

@@ -11,6 +11,9 @@ from Gui.ViewProviderDocumentObject import ViewProviderDocumentObject
class ViewProviderFemPostPipeline(ViewProviderDocumentObject):
"""
ViewProviderFemPostPipeline class
Author: Uwe Stöhr (uwestoehr@lyx.org)
License: LGPL-2.1-or-later
"""
def transformField(self) -> Any:

View File

@@ -13,6 +13,9 @@ class StepShape(PyObjectBase):
"""
StepShape in Import
This class gives a interface to retrieve TopoShapes out of an loaded STEP file of any kind.
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
"""
def read(self) -> Any:

View File

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

View File

@@ -11,6 +11,9 @@ from Base.Metadata import export
class Measurement(BaseClass):
"""
Make a measurement
Author: Luke Parry (l.parry@warwick.ac.uk)
License: LGPL-2.1-or-later
"""
def addReference3D(self) -> Any:

View File

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

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:

View File

@@ -19,6 +19,9 @@ class Points(object):
This class allows one to manipulate the Points object by adding new points, deleting facets, importing from an STL file,
transforming and much more.
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
"""
@constmethod

View File

@@ -12,6 +12,9 @@ from Base.Persistence import Persistence
class Robot6Axis(Persistence):
"""
Robot6Axis class
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
"""
def check(self) -> Any:

View File

@@ -11,6 +11,9 @@ from App.DocumentObject import DocumentObject
class RobotObject(DocumentObject):
"""
Robot document object
Author: Juergen Riegel (FreeCAD@juergen-riegel.net)
License: LGPL-2.1-or-later
"""
def getRobot(self) -> Any:

View File

@@ -12,6 +12,9 @@ from Base.Persistence import Persistence
class Trajectory(Persistence):
"""
Trajectory class
Author: Juergen Riegel (Juergen.Riegel@web.de)
License: LGPL-2.1-or-later
"""
def insertWaypoints(self) -> Any:

View File

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

View File

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

View File

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

View File

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

View File

@@ -12,6 +12,9 @@ from App.DocumentObject import DocumentObject
class Sheet(DocumentObject):
"""
With this object you can manipulate spreadsheets
Author: Eivind Kvedalen (eivind@kvedalen.name)
License: LGPL-2.1-or-later
"""
def set(self) -> Any:

View File

@@ -13,6 +13,9 @@ from Gui.ViewProviderDocumentObject import ViewProviderDocumentObject
class ViewProviderSpreadsheet(ViewProviderDocumentObject):
"""
ViewProviderSheet class
Author: Jose Luis Cercos Pita (jlcercos@gmail.com)
License: LGPL-2.1-or-later
"""
def getView(self) -> Any:

View File

@@ -13,6 +13,9 @@ class BlendCurve(PyObjectBase):
"""
Create a BlendCurve that interpolate 2 BlendPoints.
curve = BlendCurve(BlendPoint1, BlendPoint2)
Author: Mattéo Grellier (matteogrellier@gmail.com)
License: LGPL-2.1-or-later
"""
def compute(self) -> Any:

View File

@@ -15,6 +15,9 @@ class BlendPoint(PyObjectBase):
myBlendPoint = BlendPoint([Point, D1, D2, ..., DN])
BlendPoint can also be constructed from an edge
myBlendPoint = BlendPoint(Edge, parameter = float, continuity = int)
Author: Mattéo Grellier (matteogrellier@gmail.com)
License: LGPL-2.1-or-later
"""
@constmethod

View File

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

View File

@@ -13,6 +13,9 @@ from Base.Metadata import export
class CosmeticEdge(PyObjectBase):
"""
CosmeticEdge specifies an extra (cosmetic) edge in Views
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
"""
Tag: Final[str]

View File

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

View File

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

View File

@@ -11,6 +11,9 @@ from TechDraw.DrawViewPart import DrawViewPart
class DrawBrokenView(DrawViewPart):
"""
Feature for creating and manipulating Technical Drawing broken views
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
"""
def mapPoint3dToView(self) -> Any:

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -11,6 +11,9 @@ from TechDraw.DrawViewCollection import DrawViewCollection
class DrawProjGroup(DrawViewCollection):
"""
Feature for creating and manipulating Technical Drawing Projection Groups
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
"""
def addProjection(self) -> Any:

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -11,6 +11,9 @@ from App.DocumentObject import DocumentObject
class DrawView(DocumentObject):
"""
Feature for creating and manipulating Technical Drawing Views
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
"""
def translateLabel(self) -> Any:

View File

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

View File

@@ -11,6 +11,9 @@ from TechDraw.DrawView import DrawView
class DrawViewClip(DrawView):
"""
Feature for creating and manipulating Technical Drawing Clip Views
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
"""
def addView(self) -> Any:

View File

@@ -11,6 +11,9 @@ from TechDraw.DrawView import DrawView
class DrawViewCollection(DrawView):
"""
Feature for creating and manipulating Technical Drawing View Collections
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
"""
def addView(self) -> Any:

View File

@@ -11,6 +11,9 @@ from TechDraw.DrawViewDimension import DrawViewDimension
class DrawViewDimExtent(DrawViewDimension):
"""
Feature for creating and manipulating Technical Drawing DimExtents
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
"""
def tbd(self) -> Any:

View File

@@ -11,6 +11,9 @@ from TechDraw.DrawView import DrawView
class DrawViewDimension(DrawView):
"""
Feature for creating and manipulating Technical Drawing Dimensions
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
"""
def getRawValue(self) -> Any:

View File

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

View File

@@ -11,6 +11,9 @@ from TechDraw.DrawView import DrawView
class DrawViewSymbol(DrawView):
"""
Feature for creating and manipulating Drawing SVG Symbol Views
Author: WandererFan (wandererfan@gmail.com)
License: LGPL-2.1-or-later
"""
def dumpSymbol(self) -> Any:

View File

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

View File

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