Draft: add modules of draftmake to the proper Doxygen group

This includes `make_arc_3points`, `make_array`, `make_bezcurve`,
`make_block`, `make_bspline`, `make_circle`, `make_circulararray`,
`make_clone`, `make_copy`, `make_dimension`, `make_drawingview`,
`make_ellipse`, `make_facebinder`, `make_fillet`, `make_label`,
`make_line`, `make_orthoarray`, `make_patharray`, `make_point`,
`make_pointarray`, `make_polararray`, `make_polygon`,
`make_rectangle`, `make_shape2dview`, `make_shapestring`,
`make_sketch`, `make_text`, `make_wire`, `make_wpproxy`.

These are added to the `draftmake` Doxygen group
so that the functions contained in each module are listed
appropriately in the automatically generated documentation.
This commit is contained in:
vocx-fc
2020-06-30 21:24:16 -05:00
committed by Yorik van Havre
parent f4611f0a31
commit a82d6b9801
29 changed files with 294 additions and 227 deletions

View File

@@ -20,20 +20,19 @@
# * USA *
# * *
# ***************************************************************************
"""This module provides the code for Draft make_rectangle function.
"""
"""Provides functions to create Rectangle objects."""
## @package make_rectangle
# \ingroup DRAFT
# \ingroup draftmake
# \brief This module provides the code for Draft make_rectangle function.
## \addtogroup draftmake
# @{
import FreeCAD as App
from draftutils.gui_utils import format_object
from draftutils.gui_utils import select
from draftutils.utils import type_check
import draftutils.utils as utils
import draftutils.gui_utils as gui_utils
from draftobjects.rectangle import Rectangle
if App.GuiUp:
from draftviewproviders.view_rectangle import ViewProviderRectangle
@@ -75,7 +74,8 @@ def make_rectangle(length, height=0, placement=None, face=None, support=None):
rp = App.Placement(verts[0],rr)
return makeRectangle(xv.Length,yv.Length,rp,face,support)
if placement: type_check([(placement,App.Placement)], "make_rectangle")
if placement:
utils.type_check([(placement,App.Placement)], "make_rectangle")
obj = App.ActiveDocument.addObject("Part::Part2DObjectPython","Rectangle")
Rectangle(obj)
@@ -91,10 +91,12 @@ def make_rectangle(length, height=0, placement=None, face=None, support=None):
if App.GuiUp:
ViewProviderRectangle(obj.ViewObject)
format_object(obj)
select(obj)
gui_utils.format_object(obj)
gui_utils.select(obj)
return obj
makeRectangle = make_rectangle
## @}