Draft: add modules of draftutils to the proper Doxygen group

This includes `gui_utils`, `init_draft_statusbar`, `init_tools`,
`messages`, `todo`, `translate`, `utils`.

These are added to the `draftutils` 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-07-01 13:25:18 -05:00
committed by Yorik van Havre
parent e853503907
commit dd70caa723
9 changed files with 93 additions and 55 deletions

View File

@@ -23,18 +23,20 @@
# * USA *
# * *
# ***************************************************************************
"""Provides utility functions for managing groups in the Draft Workbench.
"""Provides utility functions to do operations with groups.
The functions here are also used in the Arch Workbench as some of
the objects created with this workbench work like groups.
"""
## @package groups
# \ingroup DRAFT
# \brief Provides utility functions for managing groups in the Draft Workbench.
# \ingroup draftutils
# \brief Provides utility functions to do operations with groups.
## \addtogroup draftutils
# @{
import FreeCAD as App
import draftutils.utils as utils
from draftutils.translate import _tr
from draftutils.messages import _msg, _err
@@ -326,3 +328,5 @@ def getMovableChildren(objectslist, recursive=True):
"""Return a list of objects with child objects. DEPRECATED."""
utils.use_instead("get_movable_children")
return get_movable_children(objectslist, recursive)
## @}