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

@@ -25,7 +25,7 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the object code for the Draft PathArray object.
"""Provides the object code for the PathArray object.
The copies will be placed along a path like a polyline, spline, or bezier
curve, and along the selected subelements.
@@ -60,8 +60,8 @@ objects. Therefore, the first solution is simpler, that is, using
a single property of type `App::PropertyLinkSub`.
"""
## @package patharray
# \ingroup DRAFT
# \brief Provides the object code for the Draft PathArray object.
# \ingroup draftobjects
# \brief Provides the object code for the PathArray object.
import FreeCAD as App
import DraftVecUtils
@@ -76,6 +76,9 @@ from draftobjects.draftlink import DraftLink
Part = lz.LazyLoader("Part", globals(), "Part")
DraftGeomUtils = lz.LazyLoader("DraftGeomUtils", globals(), "DraftGeomUtils")
## \addtogroup draftobjects
# @{
class PathArray(DraftLink):
"""The Draft Path Array object.
@@ -428,6 +431,7 @@ class PathArray(DraftLink):
_wrn("v0.19, " + obj.Label + ", " + _tr(_info))
# Alias for compatibility with v0.18 and earlier
_PathArray = PathArray
@@ -617,3 +621,5 @@ def get_parameter_from_v0(edge, offset):
getParameterFromV0 = get_parameter_from_v0
## @}