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

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