kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Draft: add modules of drafttaskpanels to the proper Doxygen group

Browse Source 
This includes `task_circulararray`, `task_orthoarray`,
`task_polararray`, `task_scale`, `task_selectplane`,
`task_shapestring`.

These are added to the `drafttaskpanels` 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 22:13:26 -05:00
committed by Yorik van Havre
parent 42599838f4
commit d70a194dc7
6 changed files with 72 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
src/Mod/Draft/drafttaskpanels/task_selectplane.py
View File

@@ -20,24 +20,27 @@
# * USA *
# * *
# ***************************************************************************
"""Provides the task panel for the Draft SelectPlane tool."""
"""Provides the task panel code for the Draft SelectPlane tool.
As it is right now this code only loads the task panel .ui file.
All logic on how to use the widgets is located in the GuiCommand class
itself.
On the other hand, the newer tools introduced in v0.19 like OrthoArray,
PolarArray, and CircularArray include the logic and manipulation
of the widgets in this task panel class.
In addition, the task panel code launches the actual function
using the delayed mechanism defined by the `todo.ToDo` class.
Therefore, at some point this class should be refactored
to be more similar to OrthoArray and the new tools.
"""
## @package task_selectplane
# \ingroup DRAFT
# \brief This module provides the task panel code for the SelectPlane tool.
# \ingroup drafttaskpanels
# \brief Provides the task panel code for the Draft SelectPlane tool.
## \addtogroup drafttaskpanels
# @{
import FreeCADGui as Gui
# As it is right now this code only loads the task panel .ui file.
# All logic on how to use the widgets is located in the GuiCommand class
# itself.
# On the other hand, the newer tools introduced in v0.19 like OrthoArray,
# PolarArray, and CircularArray include the logic and manipulation
# of the widgets in this task panel class.
# In addition, the task panel code launches the actual function
# using the delayed mechanism defined by the `todo.ToDo` class.
# Therefore, at some point this class should be refactored
# to be more similar to OrthoArray and the new tools.
class SelectPlaneTaskPanel:
"""The task panel definition of the Draft_SelectPlane command."""
@@ -48,3 +51,5 @@ class SelectPlaneTaskPanel:
def getStandardButtons(self):
"""Execute to set the standard buttons."""
return 2097152 # int(QtGui.QDialogButtonBox.Close)
## @}