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

@@ -18,7 +18,7 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the object code for the Draft Link object.
"""Provides the base class for Link objects used by other objects.
This class was created by realthunder during the `LinkMerge`
to demonstrate how to use the `App::Link` objects to create
@@ -31,8 +31,8 @@ on how the properties are being set, and how the code interacts with
the arrays that use it.
"""
## @package draftlink
# \ingroup DRAFT
# \brief Provides the object code for the Draft Link object.
# \ingroup draftobjects
# \brief Provides the base class for Link objects used by other objects.
import lazy_loader.lazy_loader as lz
from PySide.QtCore import QT_TRANSLATE_NOOP
@@ -46,6 +46,9 @@ from draftobjects.base import DraftObject
Part = lz.LazyLoader("Part", globals(), "Part")
DraftGeomUtils = lz.LazyLoader("DraftGeomUtils", globals(), "DraftGeomUtils")
## \addtogroup draftobjects
# @{
class DraftLink(DraftObject):
"""New class to use the App::Link objects in arrays.
@@ -224,3 +227,5 @@ class DraftLink(DraftObject):
# Alias for compatibility with old versions of v0.19
_DraftLink = DraftLink
## @}