Draft: add modules of draftobjects to the proper Doxygen group

This includes `array`, `base`, `bezcurve`, `block`, `bspline`,
`circle`, `clone`, `dimension`, `draft_annotation`, `draftlink`,
`drawingview`, `ellipse`, `facebinder`, `fillet`, `label`,
`patharray`, `point`, `pointarray`, `polygon`, `rectangle`,
`shape2dview`, `shapestring`, `text`, `wire`, `wwproxy`.

These are added to the `draftobjects` Doxygen group
so that the functions and classes contained in each module
are listed appropriately in the automatically generated
documentation.
This commit is contained in:
vocx-fc
2020-06-30 21:50:24 -05:00
committed by Yorik van Havre
parent a82d6b9801
commit 27fc2e89fb
25 changed files with 240 additions and 143 deletions

View File

@@ -20,19 +20,29 @@
# * USA *
# * *
# ***************************************************************************
"""This module provides the object code for the Draft DrawingView object.
This module is obsolete, since Drawing was substituted by TechDraw.
"""Provides the object code for the DrawingView object (OBSOLETE).
This module is obsolete, since the Drawing Workbench stopped
being developed in v0.17.
The TechDraw Workbench replaces Drawing, and it no longer requires
a `DrawingView` object to display objects in a drawing sheet.
This module is still provided in order to be able to open older files
that use this `DrawingView` object. However, a GUI tool to create
this object should no longer be available.
"""
## @package drawingview
# \ingroup DRAFT
# \brief This module provides the object code for the Draft DrawingView object.
# \ingroup draftobjects
# \brief Provides the object code for the DrawingView object (OBSOLETE).
## \addtogroup draftobjects
# @{
from PySide.QtCore import QT_TRANSLATE_NOOP
import getSVG
import draftutils.utils as utils
import draftutils.groups as groups
from draftobjects.base import DraftObject
@@ -124,4 +134,7 @@ class DrawingView(DraftObject):
return utils.getDXF(obj)
# Alias for compatibility with v0.18 and earlier
_DrawingView = DrawingView
## @}