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

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