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

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