From e3da57207299d273f31b84869a41fe13b3758a2e Mon Sep 17 00:00:00 2001 From: vocx-fc Date: Tue, 30 Jun 2020 16:53:15 -0500 Subject: [PATCH] Draft: add modules of draftguitools to the proper Doxygen group This includes `gui_annotationstyleeditor`, `gui_arcs`, `gui_array_simple`, `gui_arrays`, `gui_base`, `gui_base_original`, `gui_beziers`, `gui_circles`, `gui_circulararray`, `gui_clone`, `gui_circulararray`, `gui_clone`, `gui_dimension_ops`, `gui_dimensions`, `gui_downgrade`, `gui_draft2sketch`, `gui_drawing`, `gui_edit`, `gui_edit_arch_objects`, `gui_edit_draft_objects`, `gui_edit_part_objects`, `gui_edit_sketcher_objects`, `gui_ellipses`, `gui_facebinders`, `gui_fillets`, `gui_grid`, `gui_groups`, `gui_heal`, `gui_join`, `gui_labels`, `gui_line_add_delete`, `gui_lineops`, `gui_lines`, `gui_lineslope`, `gui_mirror`, `gui_move`, `gui_offset`, `gui_orthoarray`, `gui_patharray`, `gui_planeproxy`, `gui_pointarray`, `gui_points`, `gui_polararray`, `gui_polygons`, `gui_rectangles`, `gui_rotate`, `gui_scale`, `gui_selectplane`, `gui_shape2dview`, `gui_shapestrings`, `gui_snapper`, `gui_snaps`, `gui_splines`, `gui_split`, `gui_stretch`, `gui_styles`, `gui_subeleemnts`, `gui_texts`, `gui_togglemodes`, `gui_tools_utils`, `gui_trackers`, `gui_trimex`, `gui_upgrade`, `gui_wire2spline`. These are added to the `draftguitools` Doxygen group so that the functions and classes contained in each module are listed appropriately in the automatically generated documentation. --- .../gui_annotationstyleeditor.py | 9 +++++- src/Mod/Draft/draftguitools/gui_arcs.py | 10 +++++-- .../Draft/draftguitools/gui_array_simple.py | 10 +++++-- src/Mod/Draft/draftguitools/gui_arrays.py | 10 +++++-- src/Mod/Draft/draftguitools/gui_base.py | 11 ++++++-- .../Draft/draftguitools/gui_base_original.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_beziers.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_circles.py | 10 +++++-- .../Draft/draftguitools/gui_circulararray.py | 10 +++++-- src/Mod/Draft/draftguitools/gui_clone.py | 10 +++++-- .../Draft/draftguitools/gui_dimension_ops.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_dimensions.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_downgrade.py | 10 +++++-- .../Draft/draftguitools/gui_draft2sketch.py | 10 +++++-- src/Mod/Draft/draftguitools/gui_drawing.py | 10 +++++-- src/Mod/Draft/draftguitools/gui_edit.py | 28 +++++++++---------- .../draftguitools/gui_edit_arch_objects.py | 12 +++++--- .../draftguitools/gui_edit_draft_objects.py | 10 ++++--- .../draftguitools/gui_edit_part_objects.py | 11 +++++--- .../gui_edit_sketcher_objects.py | 14 ++++++---- src/Mod/Draft/draftguitools/gui_ellipses.py | 11 ++++++-- .../Draft/draftguitools/gui_facebinders.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_fillets.py | 14 ++++++---- src/Mod/Draft/draftguitools/gui_grid.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_groups.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_heal.py | 13 ++++++--- src/Mod/Draft/draftguitools/gui_join.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_labels.py | 10 +++++-- .../draftguitools/gui_line_add_delete.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_lineops.py | 12 ++++++-- src/Mod/Draft/draftguitools/gui_lines.py | 13 ++++++--- src/Mod/Draft/draftguitools/gui_lineslope.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_mirror.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_move.py | 14 ++++++---- src/Mod/Draft/draftguitools/gui_offset.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_orthoarray.py | 10 +++++-- src/Mod/Draft/draftguitools/gui_patharray.py | 10 +++++-- src/Mod/Draft/draftguitools/gui_planeproxy.py | 10 +++++-- src/Mod/Draft/draftguitools/gui_pointarray.py | 10 +++++-- src/Mod/Draft/draftguitools/gui_points.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_polararray.py | 10 +++++-- src/Mod/Draft/draftguitools/gui_polygons.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_rectangles.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_rotate.py | 11 +++++--- src/Mod/Draft/draftguitools/gui_scale.py | 11 +++++--- .../Draft/draftguitools/gui_selectplane.py | 15 ++++++---- .../Draft/draftguitools/gui_shape2dview.py | 11 ++++++-- .../Draft/draftguitools/gui_shapestrings.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_snapper.py | 27 +++++++++--------- src/Mod/Draft/draftguitools/gui_snaps.py | 15 ++++++---- src/Mod/Draft/draftguitools/gui_splines.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_split.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_stretch.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_styles.py | 11 ++++++-- .../Draft/draftguitools/gui_subelements.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_texts.py | 12 +++++--- .../Draft/draftguitools/gui_togglemodes.py | 18 ++++++++---- src/Mod/Draft/draftguitools/gui_tool_utils.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_trackers.py | 16 +++++++---- src/Mod/Draft/draftguitools/gui_trimex.py | 11 ++++++-- src/Mod/Draft/draftguitools/gui_upgrade.py | 11 ++++++-- .../Draft/draftguitools/gui_wire2spline.py | 11 ++++++-- 62 files changed, 501 insertions(+), 232 deletions(-) diff --git a/src/Mod/Draft/draftguitools/gui_annotationstyleeditor.py b/src/Mod/Draft/draftguitools/gui_annotationstyleeditor.py index a71ea26e1f..f17b2aa143 100644 --- a/src/Mod/Draft/draftguitools/gui_annotationstyleeditor.py +++ b/src/Mod/Draft/draftguitools/gui_annotationstyleeditor.py @@ -19,8 +19,13 @@ # * USA * # * * # *************************************************************************** -"""Provides all gui and tools to create and edit annotation styles.""" +"""Provides GUI tools to create and edit annotation styles.""" +## @package gui_annotationstyleeditor +# \ingroup draftguitools +# \brief Provides GUI tools to create and edit annotation styles. +## \addtogroup draftguitools +# @{ import json import PySide.QtGui as QtGui from PySide.QtCore import QT_TRANSLATE_NOOP @@ -348,3 +353,5 @@ class AnnotationStyleEditor(gui_base.GuiCommandSimplest): Gui.addCommand('Draft_AnnotationStyleEditor', AnnotationStyleEditor()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_arcs.py b/src/Mod/Draft/draftguitools/gui_arcs.py index 5f7a483d1a..9352adb188 100644 --- a/src/Mod/Draft/draftguitools/gui_arcs.py +++ b/src/Mod/Draft/draftguitools/gui_arcs.py @@ -22,11 +22,13 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating circular arcs with the Draft Workbench.""" +"""Provides GUI tools to create circular arc objects.""" ## @package gui_arcs -# \ingroup DRAFT -# \brief Provides tools for creating circular arcs with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create circular arc objects. +## \addtogroup draftguitools +# @{ import math from PySide.QtCore import QT_TRANSLATE_NOOP @@ -616,3 +618,5 @@ class ArcGroup: Gui.addCommand('Draft_ArcTools', ArcGroup()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_array_simple.py b/src/Mod/Draft/draftguitools/gui_array_simple.py index c17d8386a2..37a3bf9070 100644 --- a/src/Mod/Draft/draftguitools/gui_array_simple.py +++ b/src/Mod/Draft/draftguitools/gui_array_simple.py @@ -22,16 +22,18 @@ # * USA * # * * # *************************************************************************** -"""Provides simple tools for creating arrays with the Draft Workbench. +"""Provides GUI tools to create parametric Array objects (OBSOLETE). These commands were replaced by individual commands `Draft_OrthoArray`, `Draft_PolarArray`, and `Draft_CircularArray` which launch their own task panel, and provide a more useful way of creating the desired array. """ ## @package gui_array_simple -# \ingroup DRAFT -# \brief Provides simple tools for creating arrays with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create parametric Array objects (OBSOLETE). +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui @@ -132,3 +134,5 @@ class LinkArray(Array): Gui.addCommand('Draft_LinkArray', LinkArray()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_arrays.py b/src/Mod/Draft/draftguitools/gui_arrays.py index 066f4379dd..92964db901 100644 --- a/src/Mod/Draft/draftguitools/gui_arrays.py +++ b/src/Mod/Draft/draftguitools/gui_arrays.py @@ -20,11 +20,13 @@ # * USA * # * * # *************************************************************************** -"""Provide the Draft ArrayTools command to group the other array tools.""" +"""Provides GUI tools to create parametric Array objects. Grouping command.""" ## @package gui_arrays -# \ingroup DRAFT -# \brief Provide the Draft ArrayTools command to group the other array tools. +# \ingroup draftguitools +# \brief Provides GUI tools to create parametric Array objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui @@ -73,3 +75,5 @@ class ArrayGroup: Gui.addCommand('Draft_ArrayTools', ArrayGroup()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_base.py b/src/Mod/Draft/draftguitools/gui_base.py index 9cfac4b812..fd1b3ab9ee 100644 --- a/src/Mod/Draft/draftguitools/gui_base.py +++ b/src/Mod/Draft/draftguitools/gui_base.py @@ -22,14 +22,17 @@ # * USA * # * * # *************************************************************************** -"""Provide the Base object for all Draft Gui commands.""" +"""Provides the base classes for newer Draft Gui Commands.""" ## @package gui_base -# \ingroup DRAFT -# \brief This module provides the Base object for all Draft Gui commands. +# \ingroup draftguitools +# \brief Provides the base classes for newer Draft Gui Commands. +## \addtogroup draftguitools +# @{ import FreeCAD as App import FreeCADGui as Gui import draftutils.todo as todo + from draftutils.messages import _msg, _log __metaclass__ = type # to support Python 2 use of `super()` @@ -214,3 +217,5 @@ class GuiCommandBase: that will be executed. """ self.commit_list.append((name, func)) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_base_original.py b/src/Mod/Draft/draftguitools/gui_base_original.py index a7f666433c..89a091b01c 100644 --- a/src/Mod/Draft/draftguitools/gui_base_original.py +++ b/src/Mod/Draft/draftguitools/gui_base_original.py @@ -22,15 +22,17 @@ # * USA * # * * # *************************************************************************** -"""Provides the Base object for most old Draft Gui Commands. +"""Provides the base classes for most old Draft Gui Commands. This class is used by Gui Commands to set up some properties of the DraftToolBar, the Snapper, and the working plane. """ ## @package gui_base_original -# \ingroup DRAFT -# \brief Provides the Base object for most old Draft Gui Commands. +# \ingroup draftguitools +# \brief Provides the base classes for most old Draft Gui Commands. +## \addtogroup draftguitools +# @{ import FreeCAD as App import FreeCADGui as Gui import DraftVecUtils @@ -39,6 +41,7 @@ import draftutils.gui_utils as gui_utils import draftutils.todo as todo import draftguitools.gui_trackers as trackers import draftguitools.gui_tool_utils as gui_tool_utils + from draftutils.messages import _msg, _log __metaclass__ = type # to support Python 2 use of `super()` @@ -302,3 +305,5 @@ class Modifier(DraftTool): def __init__(self): super(Modifier, self).__init__() self.copymode = False + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_beziers.py b/src/Mod/Draft/draftguitools/gui_beziers.py index d3a7749919..d93a0f3c6a 100644 --- a/src/Mod/Draft/draftguitools/gui_beziers.py +++ b/src/Mod/Draft/draftguitools/gui_beziers.py @@ -22,7 +22,7 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating Bezier curves with the Draft Workbench. +"""Provides GUI tools to create BezCurve objects. In particular, a cubic Bezier curve is defined, as it is one of the most useful curves for many applications. @@ -30,9 +30,11 @@ useful curves for many applications. See https://en.wikipedia.org/wiki/B%C3%A9zier_curve """ ## @package gui_beziers -# \ingroup DRAFT -# \brief Provides tools for creating Bezier curves with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create BezCurve objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui @@ -42,6 +44,7 @@ import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils import draftguitools.gui_lines as gui_lines import draftguitools.gui_trackers as trackers + from draftutils.messages import _msg, _err from draftutils.translate import translate @@ -500,3 +503,5 @@ class BezierGroup: Gui.addCommand('Draft_BezierTools', BezierGroup()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_circles.py b/src/Mod/Draft/draftguitools/gui_circles.py index 3119c3b648..23378b2985 100644 --- a/src/Mod/Draft/draftguitools/gui_circles.py +++ b/src/Mod/Draft/draftguitools/gui_circles.py @@ -22,11 +22,13 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating circles with the Draft Workbench.""" +"""Provides GUI tools to create Circle objects.""" ## @package gui_circles -# \ingroup DRAFT -# \brief Provides tools for creating circlres with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create Circle objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui @@ -81,3 +83,5 @@ class Circle(gui_arcs.Arc): Gui.addCommand('Draft_Circle', Circle()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_circulararray.py b/src/Mod/Draft/draftguitools/gui_circulararray.py index 78ecaf2a82..e98a8d0d31 100644 --- a/src/Mod/Draft/draftguitools/gui_circulararray.py +++ b/src/Mod/Draft/draftguitools/gui_circulararray.py @@ -20,11 +20,13 @@ # * USA * # * * # *************************************************************************** -"""Provides the Draft CircularArray GuiCommand.""" +"""Provides GUI tools to create circular Array objects.""" ## @package gui_circulararray -# \ingroup DRAFT -# \brief This module provides the Draft CircularArray tool. +# \ingroup draftguitools +# \brief Provides GUI tools to create circular Array objects. +## \addtogroup draftguitools +# @{ from pivy import coin from PySide.QtCore import QT_TRANSLATE_NOOP @@ -142,3 +144,5 @@ class CircularArray(gui_base.GuiCommandBase): Gui.addCommand('Draft_CircularArray', CircularArray()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_clone.py b/src/Mod/Draft/draftguitools/gui_clone.py index 4799243080..bbe1be68f8 100644 --- a/src/Mod/Draft/draftguitools/gui_clone.py +++ b/src/Mod/Draft/draftguitools/gui_clone.py @@ -22,7 +22,7 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating clones of objects with the Draft Workbench. +"""Provides GUI tools to create Clone objects. The clone is basically a simple copy of the `Shape` of another object, whether that is a Draft object or any other 3D object. @@ -35,9 +35,11 @@ more memory efficient as it reuses the same internal `Shape` instead of creating a copy of it. """ ## @package gui_clone -# \ingroup DRAFT -# \brief Provides tools for creating clones of objects. +# \ingroup draftguitools +# \brief Provides GUI tools to create Clone objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App @@ -123,3 +125,5 @@ class Clone(gui_base_original.Modifier): Draft_Clone = Clone Gui.addCommand('Draft_Clone', Clone()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_dimension_ops.py b/src/Mod/Draft/draftguitools/gui_dimension_ops.py index abba6220a0..c19c75f5f3 100644 --- a/src/Mod/Draft/draftguitools/gui_dimension_ops.py +++ b/src/Mod/Draft/draftguitools/gui_dimension_ops.py @@ -22,20 +22,23 @@ # * USA * # * * # *************************************************************************** -"""Provides tools to modify Draft dimensions. +"""Provides GUI tools to modify dimension objects. For example, a tool to flip the direction of the text in the dimension as the normal is sometimes not correctly calculated automatically. """ ## @package gui_dimension_ops -# \ingroup DRAFT -# \brief Provides tools to modify Draft dimensions. +# \ingroup draftguitools +# \brief Provides GUI tools to modify dimension objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui import draftutils.utils as utils import draftguitools.gui_base as gui_base + from draftutils.translate import _tr @@ -81,3 +84,5 @@ class FlipDimension(gui_base.GuiCommandNeedsSelection): Draft_FlipDimension = FlipDimension Gui.addCommand('Draft_FlipDimension', FlipDimension()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_dimensions.py b/src/Mod/Draft/draftguitools/gui_dimensions.py index 805d18bd42..0b37e41f9f 100644 --- a/src/Mod/Draft/draftguitools/gui_dimensions.py +++ b/src/Mod/Draft/draftguitools/gui_dimensions.py @@ -22,7 +22,7 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating dimension objects with the Draft Workbench. +"""Provides GUI tools to create dimension objects. The objects can be simple linear dimensions that measure between two arbitrary points, or linear dimensions linked to an edge. @@ -32,8 +32,8 @@ And it can also be an angular dimension measuring the angle between two straight lines. """ ## @package gui_dimensions -# \ingroup DRAFT -# \brief Provides tools for creating dimensions with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create dimension objects. import math import lazy_loader.lazy_loader as lz @@ -55,6 +55,9 @@ DraftGeomUtils = lz.LazyLoader("DraftGeomUtils", globals(), "DraftGeomUtils") # The module is used to prevent complaints from code checkers (flake8) True if Draft_rc.__name__ else False +## \addtogroup draftguitools +# @{ + class Dimension(gui_base_original.Creator): """Gui command for the Dimension tool. @@ -578,3 +581,5 @@ class Dimension(gui_base_original.Creator): Gui.addCommand('Draft_Dimension', Dimension()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_downgrade.py b/src/Mod/Draft/draftguitools/gui_downgrade.py index ff9736da27..4bc95bf053 100644 --- a/src/Mod/Draft/draftguitools/gui_downgrade.py +++ b/src/Mod/Draft/draftguitools/gui_downgrade.py @@ -22,16 +22,18 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for downgrading objects with the Draft Workbench. +"""Provides GUI tools to downgrade objects. Downgrades 2D objects to simpler objects until it reaches simple Edge primitives. For example, a Draft Line to wire, and then to a series of edges. """ ## @package gui_downgrade -# \ingroup DRAFT -# \brief Provides tools for downgrading objects with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to downgrade objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui @@ -95,3 +97,5 @@ class Downgrade(gui_base_original.Modifier): Gui.addCommand('Draft_Downgrade', Downgrade()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_draft2sketch.py b/src/Mod/Draft/draftguitools/gui_draft2sketch.py index f3ada9be91..acfed8c837 100644 --- a/src/Mod/Draft/draftguitools/gui_draft2sketch.py +++ b/src/Mod/Draft/draftguitools/gui_draft2sketch.py @@ -22,7 +22,7 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for converting Draft objects to Sketches and back. +"""Provides GUI tools to convert Draft objects to Sketches and back. Many Draft objects will be converted to a single non-contrainted Sketch. @@ -30,9 +30,11 @@ However, a single sketch with disconnected traces will be converted into several individual Draft objects. """ ## @package gui_draft2sketch -# \ingroup DRAFT -# \brief Provides tools for converting Draft objects to Sketches and back. +# \ingroup draftguitools +# \brief Provides GUI tools to convert Draft objects to Sketches and back. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui @@ -153,3 +155,5 @@ class Draft2Sketch(gui_base_original.Modifier): Gui.addCommand('Draft_Draft2Sketch', Draft2Sketch()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_drawing.py b/src/Mod/Draft/draftguitools/gui_drawing.py index 37b2cfaa8d..2b4800636c 100644 --- a/src/Mod/Draft/draftguitools/gui_drawing.py +++ b/src/Mod/Draft/draftguitools/gui_drawing.py @@ -22,7 +22,7 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for sending projections to a Drawing Workbench page. +"""Provides GUI tools to project an object into a Drawing Workbench page. This commands takes a 2D geometrical element and creates a projection that is displayed in a drawing page in the Drawing Workbench. @@ -35,9 +35,11 @@ it is not really necessary. TechDraw has its own set of tools to create 2D projections of 2D and 3D objects. """ ## @package gui_drawing -# \ingroup DRAFT -# \brief Provides tools for sending projections to a Drawing Workbench page. +# \ingroup draftguitools +# \brief Provides GUI tools to project an object into a Drawing Workbench page. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App @@ -149,3 +151,5 @@ class Drawing(gui_base_original.Modifier): Gui.addCommand('Draft_Drawing', Drawing()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_edit.py b/src/Mod/Draft/draftguitools/gui_edit.py index 01d5640f94..f8a6404aae 100644 --- a/src/Mod/Draft/draftguitools/gui_edit.py +++ b/src/Mod/Draft/draftguitools/gui_edit.py @@ -20,41 +20,37 @@ # * USA * # * * # *************************************************************************** -"""Provide the Draft_Edit command used by the Draft workbench.""" +"""Provides GUI tools to start the edit mode of different objects.""" ## @package gui_edit -# \ingroup DRAFT -# \brief Provide the Draft_Edit command used by the Draft workbench +# \ingroup draftguitools +# \brief Provides GUI tools to start the edit mode of different objects. __title__ = "FreeCAD Draft Edit Tool" __author__ = ("Yorik van Havre, Werner Mayer, Martin Burbaum, Ken Cline, " "Dmitry Chigrin, Carlo Pavan") __url__ = "https://www.freecadweb.org" - +## \addtogroup draftguitools +# @{ import math -from pivy import coin -from PySide import QtCore, QtGui +import pivy.coin as coin +import PySide.QtCore as QtCore +import PySide.QtGui as QtGui import FreeCAD as App import FreeCADGui as Gui - +import DraftVecUtils import draftutils.utils as utils - +import draftutils.gui_utils as gui_utils import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils -import draftutils.gui_utils as gui_utils - -import DraftVecUtils -import DraftGeomUtils - -from draftutils.translate import translate import draftguitools.gui_trackers as trackers - import draftguitools.gui_edit_draft_objects as edit_draft import draftguitools.gui_edit_arch_objects as edit_arch import draftguitools.gui_edit_part_objects as edit_part import draftguitools.gui_edit_sketcher_objects as edit_sketcher +from draftutils.translate import translate COLORS = { "default": Gui.draftToolBar.getDefaultColor("snap"), @@ -1234,3 +1230,5 @@ class Edit(gui_base_original.Modifier): Gui.addCommand('Draft_Edit', Edit()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_edit_arch_objects.py b/src/Mod/Draft/draftguitools/gui_edit_arch_objects.py index ad849a918e..bacbfc7017 100644 --- a/src/Mod/Draft/draftguitools/gui_edit_arch_objects.py +++ b/src/Mod/Draft/draftguitools/gui_edit_arch_objects.py @@ -20,17 +20,18 @@ # * USA * # * * # *************************************************************************** -"""Provide the support functions to Draft_Edit for Arch objects.""" +"""Provides support functions to edit Arch objects.""" ## @package gui_edit_arch_objects -# \ingroup DRAFT -# \brief Provide the support functions to Draft_Edit for Arch objects. +# \ingroup draftguitools +# \brief Provides support functions to edit Arch objects. __title__ = "FreeCAD Draft Edit Tool" __author__ = ("Yorik van Havre, Werner Mayer, Martin Burbaum, Ken Cline, " "Dmitry Chigrin, Carlo Pavan") __url__ = "https://www.freecadweb.org" - +## \addtogroup draftguitools +# @{ import math import FreeCAD as App import DraftVecUtils @@ -38,6 +39,7 @@ import DraftVecUtils from draftutils.translate import translate import draftutils.utils as utils + def get_supported_arch_objects(): return ["Wall", "Window", "Structure", "Space", "PanelCut", "PanelSheet"] @@ -174,3 +176,5 @@ def updatePanelSheet(obj, nodeIndex, v): obj.TagPosition = v else: obj.Group[nodeIndex-1].Placement.Base = v + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_edit_draft_objects.py b/src/Mod/Draft/draftguitools/gui_edit_draft_objects.py index 35db1f85fa..b0b961e819 100644 --- a/src/Mod/Draft/draftguitools/gui_edit_draft_objects.py +++ b/src/Mod/Draft/draftguitools/gui_edit_draft_objects.py @@ -20,7 +20,7 @@ # * USA * # * * # *************************************************************************** -"""Provide the support functions to Draft_Edit for Draft objects. +"""Provides support functions to edit Draft objects. All functions in this module work with Object coordinate space. No conversion to global coordinate system is needed. @@ -34,15 +34,16 @@ TODO: Abstract the code that handles the preview and move the object specific code to this module from main Draft_Edit module """ ## @package gui_edit_draft_objects -# \ingroup DRAFT -# \brief Provide the support functions to Draft_Edit for Draft objects. +# \ingroup draftguitools +# \brief Provides support functions to edit Draft objects. __title__ = "FreeCAD Draft Edit Tool" __author__ = ("Yorik van Havre, Werner Mayer, Martin Burbaum, Ken Cline, " "Dmitry Chigrin, Carlo Pavan") __url__ = "https://www.freecadweb.org" - +## \addtogroup draftguitools +# @{ import math import FreeCAD as App import DraftVecUtils @@ -511,3 +512,4 @@ def smoothBezPoint(obj, point, style='Symmetric'): obj.Points = pts obj.Continuity = newcont +## @} diff --git a/src/Mod/Draft/draftguitools/gui_edit_part_objects.py b/src/Mod/Draft/draftguitools/gui_edit_part_objects.py index 881a854735..b8ed1887cd 100644 --- a/src/Mod/Draft/draftguitools/gui_edit_part_objects.py +++ b/src/Mod/Draft/draftguitools/gui_edit_part_objects.py @@ -18,17 +18,18 @@ # * USA * # * * # *************************************************************************** -"""Provide the support functions to Draft_Edit for Part objects.""" +"""Provides support functions to edit Part objects.""" ## @package gui_edit_part_objects -# \ingroup DRAFT -# \brief Provide the support functions to Draft_Edit for Part objects. +# \ingroup draftguitools +# \brief Provides support functions to edit Part objects. __title__ = "FreeCAD Draft Edit Tool" __author__ = ("Yorik van Havre, Werner Mayer, Martin Burbaum, Ken Cline, " "Dmitry Chigrin, Carlo Pavan") __url__ = "https://www.freecadweb.org" - +## \addtogroup draftguitools +# @{ import FreeCAD as App import DraftVecUtils @@ -136,3 +137,5 @@ def updatePartSphere(obj, nodeIndex, v): elif nodeIndex == 1: if v.Length > 0.0: obj.Radius = v.Length # TODO: Perhaps better to project on the face? + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_edit_sketcher_objects.py b/src/Mod/Draft/draftguitools/gui_edit_sketcher_objects.py index 971763ce17..aec11d4696 100644 --- a/src/Mod/Draft/draftguitools/gui_edit_sketcher_objects.py +++ b/src/Mod/Draft/draftguitools/gui_edit_sketcher_objects.py @@ -20,18 +20,18 @@ # * USA * # * * # *************************************************************************** -"""Provide the support functions to Draft_Edit for Arch objects.""" -## @package gui_edit_arch_objects -# \ingroup DRAFT -# \brief Provide the support functions to Draft_Edit for Arch objects. +"""Provides support functions to edit Sketch objects.""" +## @package gui_edit_sketcher_objects +# \ingroup draftguitools +# \brief Provides support functions to edit Sketch objects. __title__ = "FreeCAD Draft Edit Tool" __author__ = ("Yorik van Havre, Werner Mayer, Martin Burbaum, Ken Cline, " "Dmitry Chigrin, Carlo Pavan") __url__ = "https://www.freecadweb.org" - -import math +## \addtogroup draftguitools +# @{ import FreeCAD as App from draftutils.translate import translate @@ -75,3 +75,5 @@ def updateSketch(obj, nodeIndex, v): elif nodeIndex == 1: obj.movePoint(0, 2, v) obj.recompute() + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_ellipses.py b/src/Mod/Draft/draftguitools/gui_ellipses.py index 79cc3497be..82014b69c1 100644 --- a/src/Mod/Draft/draftguitools/gui_ellipses.py +++ b/src/Mod/Draft/draftguitools/gui_ellipses.py @@ -22,11 +22,13 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating ellipses with the Draft Workbench.""" +"""Provides GUI tools to create Ellipse objects.""" ## @package gui_ellipses -# \ingroup DRAFT -# \brief Provides tools for creating ellipses with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create Ellipse objects. +## \addtogroup draftguitools +# @{ import math from PySide.QtCore import QT_TRANSLATE_NOOP @@ -38,6 +40,7 @@ import draftutils.utils as utils import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils import draftguitools.gui_trackers as trackers + from draftutils.translate import translate from draftutils.messages import _msg, _err @@ -202,3 +205,5 @@ class Ellipse(gui_base_original.Creator): Gui.addCommand('Draft_Ellipse', Ellipse()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_facebinders.py b/src/Mod/Draft/draftguitools/gui_facebinders.py index 23c18a11e7..0f78eb739f 100644 --- a/src/Mod/Draft/draftguitools/gui_facebinders.py +++ b/src/Mod/Draft/draftguitools/gui_facebinders.py @@ -22,16 +22,18 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating facebinders with the Draft Workbench. +"""Provides GUI tools to create Facebinder objects. A facebinder is a surface or shell created from the face of a solid object. This tool allows extracting such faces to be used for other purposes including extruding solids from faces. """ ## @package gui_facebinders -# \ingroup DRAFT -# \brief Provides tools for creating facebinders with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create Facebinder objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App @@ -39,6 +41,7 @@ import FreeCADGui as Gui import Draft_rc import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils + from draftutils.messages import _msg from draftutils.translate import translate, _tr @@ -91,3 +94,5 @@ class Facebinder(gui_base_original.Creator): Draft_Facebinder = Facebinder Gui.addCommand('Draft_Facebinder', Facebinder()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_fillets.py b/src/Mod/Draft/draftguitools/gui_fillets.py index f8619665e7..9da0afe9f4 100644 --- a/src/Mod/Draft/draftguitools/gui_fillets.py +++ b/src/Mod/Draft/draftguitools/gui_fillets.py @@ -20,17 +20,19 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating fillets between two lines. +"""Provides GUI tools to create Fillet objects between two lines. TODO: Currently this tool uses the DraftGui widgets. We want to avoid using this big module because it creates manually the interface. Instead we should provide its own .ui file and task panel, -similar to the Ortho Array tool. +similar to the OrthoArray tool. """ ## @package gui_fillet -# \ingroup DRAFT -# \brief Provides tools for creating fillets between two lines. +# \ingroup draftguitools +# \brief Provides GUI tools to create Fillet objects between two lines. +## \addtogroup draftguitools +# @{ import PySide.QtCore as QtCore from PySide.QtCore import QT_TRANSLATE_NOOP @@ -40,7 +42,7 @@ import Draft_rc import draftutils.utils as utils import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils -# import draftguitools.gui_trackers as trackers + from draftutils.messages import _msg, _err from draftutils.translate import translate, _tr @@ -202,3 +204,5 @@ class Fillet(gui_base_original.Creator): Gui.addCommand('Draft_Fillet', Fillet()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_grid.py b/src/Mod/Draft/draftguitools/gui_grid.py index 713adf8724..d74d0bfdef 100644 --- a/src/Mod/Draft/draftguitools/gui_grid.py +++ b/src/Mod/Draft/draftguitools/gui_grid.py @@ -22,15 +22,18 @@ # * USA * # * * # *************************************************************************** -"""Provide the Draft_ToggleGrid command to show the Draft grid.""" +"""Provides GUI tools to enable and disable the working plane grid.""" ## @package gui_grid -# \ingroup DRAFT -# \brief Provide the Draft_ToggleGrid command to show the Draft grid. +# \ingroup draftguitools +# \brief Provides GUI tools to enable and disable the working plane grid. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui import draftguitools.gui_base as gui_base + from draftutils.translate import _tr @@ -77,3 +80,5 @@ class ToggleGrid(gui_base.GuiCommandSimplest): Gui.addCommand('Draft_ToggleGrid', ToggleGrid()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_groups.py b/src/Mod/Draft/draftguitools/gui_groups.py index 43a020142b..305eb6ae52 100644 --- a/src/Mod/Draft/draftguitools/gui_groups.py +++ b/src/Mod/Draft/draftguitools/gui_groups.py @@ -22,16 +22,18 @@ # * USA * # * * # *************************************************************************** -"""Provides tools to do various operations with groups. +"""Provides GUI tools to do various operations with groups. For example, add objects to groups, select objects inside groups, set the automatic group in which to create objects, and add objects to the construction group. """ ## @package gui_groups -# \ingroup DRAFT -# \brief Provides tools to do various operations with groups. +# \ingroup draftguitools +# \brief Provides GUI tools to do various operations with groups. +## \addtogroup draftguitools +# @{ import PySide.QtCore as QtCore from PySide.QtCore import QT_TRANSLATE_NOOP @@ -41,6 +43,7 @@ import Draft_rc import draftutils.utils as utils import draftutils.groups as groups import draftguitools.gui_base as gui_base + from draftutils.translate import _tr, translate # The module is used to prevent complaints from code checkers (flake8) @@ -395,3 +398,5 @@ class AddToConstruction(gui_base.GuiCommandSimplest): Draft_AddConstruction = AddToConstruction Gui.addCommand('Draft_AddConstruction', AddToConstruction()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_heal.py b/src/Mod/Draft/draftguitools/gui_heal.py index f6fb61138d..6849019dd5 100644 --- a/src/Mod/Draft/draftguitools/gui_heal.py +++ b/src/Mod/Draft/draftguitools/gui_heal.py @@ -22,16 +22,19 @@ # * USA * # * * # *************************************************************************** -"""Provides the Draft_Heal command to heal older Draft files.""" -## @package gui_health -# \ingroup DRAFT -# \brief Provides the Draft_Heal command to heal older Draft files. +"""Provides GUI tools to repair objects created with older versions.""" +## @package gui_heal +# \ingroup draftguitools +# \brief Provides GUI tools to repair objects created with older versions. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui import Draft import draftguitools.gui_base as gui_base + from draftutils.translate import _tr @@ -74,3 +77,5 @@ class Heal(gui_base.GuiCommandSimplest): Gui.addCommand('Draft_Heal', Heal()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_join.py b/src/Mod/Draft/draftguitools/gui_join.py index c7afbaa2a1..12034a9635 100644 --- a/src/Mod/Draft/draftguitools/gui_join.py +++ b/src/Mod/Draft/draftguitools/gui_join.py @@ -22,7 +22,7 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for joining lines with the Draft Workbench. +"""Provides GUI tools to join lines and wires. It occasionally fails to join lines even if the lines visually share a point. This is due to the underlying `joinWires` method @@ -36,15 +36,18 @@ Test properly using `DraftVecUtils.equals` because then it will consider the precision set in the Draft preferences. """ ## @package gui_join -# \ingroup DRAFT -# \brief Provides tools for joining lines with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to join lines and wires. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui import Draft_rc import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils + from draftutils.messages import _msg from draftutils.translate import translate, _tr @@ -113,3 +116,5 @@ class Join(gui_base_original.Modifier): Gui.addCommand('Draft_Join', Join()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_labels.py b/src/Mod/Draft/draftguitools/gui_labels.py index 682e04ba7a..d3d0e6e8f2 100644 --- a/src/Mod/Draft/draftguitools/gui_labels.py +++ b/src/Mod/Draft/draftguitools/gui_labels.py @@ -22,16 +22,18 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating labels with the Draft Workbench. +"""Provides GUI tools to create Label objects. Labels are similar to text annotations but include a leader line and an arrow in order to point to an object and indicate some of its properties. """ ## @package gui_labels -# \ingroup DRAFT -# \brief Provides tools for creating labels with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create Label objects. +## \addtogroup draftguitools +# @{ import math from PySide.QtCore import QT_TRANSLATE_NOOP @@ -247,3 +249,5 @@ class Label(gui_base_original.Creator): Draft_Label = Label Gui.addCommand('Draft_Label', Label()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_line_add_delete.py b/src/Mod/Draft/draftguitools/gui_line_add_delete.py index 8482f6dd60..479bbee781 100644 --- a/src/Mod/Draft/draftguitools/gui_line_add_delete.py +++ b/src/Mod/Draft/draftguitools/gui_line_add_delete.py @@ -22,14 +22,17 @@ # * USA * # * * # *************************************************************************** -"""Provides certain add and remove line operations of the Draft Workbench. +"""Provides GUI tools to do certain add and remove line operations. These GuiCommands aren't really used anymore, as the same actions are implemented directly in the Draft_Edit command. """ ## @package gui_line_add_delete -# \ingroup DRAFT -# \brief Provides certain add and remove line operations. +# \ingroup draftguitools +# \brief Provides GUI tools to do certain add and remove line operations. + +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui @@ -107,3 +110,5 @@ class DelPoint(DraftTools.Modifier): Gui.addCommand('Draft_DelPoint', DelPoint()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_lineops.py b/src/Mod/Draft/draftguitools/gui_lineops.py index 4bd1d8e382..eeb5b41933 100644 --- a/src/Mod/Draft/draftguitools/gui_lineops.py +++ b/src/Mod/Draft/draftguitools/gui_lineops.py @@ -22,20 +22,24 @@ # * USA * # * * # *************************************************************************** -"""Provides certain line operations of the Draft Workbench. +"""Provides GUI tools to do certain line operations. These GuiCommands aren't really used anymore, as the same actions are called from the task panel interface by other methods. """ ## @package gui_lineops -# \ingroup DRAFT -# \brief Provides certain line operations in the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to do certain line operations. + +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App import FreeCADGui as Gui import Draft_rc import draftguitools.gui_base as gui_base + from draftutils.messages import _msg from draftutils.translate import _tr @@ -161,3 +165,5 @@ class UndoLine(LineAction): Gui.addCommand('Draft_UndoLine', UndoLine()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_lines.py b/src/Mod/Draft/draftguitools/gui_lines.py index 687c8247a5..d297d34ac8 100644 --- a/src/Mod/Draft/draftguitools/gui_lines.py +++ b/src/Mod/Draft/draftguitools/gui_lines.py @@ -22,17 +22,19 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating straight lines with the Draft Workbench. +"""Provides GUI tools to create straight Line and Wire objects. The Line class is used by other Gui Commands that behave in a similar way like Wire, BSpline, and BezCurve. """ ## @package gui_lines -# \ingroup DRAFT -# \brief Provides tools for creating straight lines with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create straight Line and Wire objects. -from PySide.QtCore import QT_TRANSLATE_NOOP +## \addtogroup draftguitools +# @{ import sys +from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App import FreeCADGui as Gui @@ -42,6 +44,7 @@ import draftutils.gui_utils as gui_utils import draftutils.todo as todo import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils + from draftutils.messages import _msg, _err from draftutils.translate import translate @@ -361,3 +364,5 @@ class Wire(Line): Gui.addCommand('Draft_Wire', Wire()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_lineslope.py b/src/Mod/Draft/draftguitools/gui_lineslope.py index 5738db1c95..3ce7f31329 100644 --- a/src/Mod/Draft/draftguitools/gui_lineslope.py +++ b/src/Mod/Draft/draftguitools/gui_lineslope.py @@ -22,15 +22,17 @@ # * USA * # * * # *************************************************************************** -"""Provides tools to change the slope of a line over the working plane. +"""Provides GUI tools to change the slope of a line. It currently only works for a line in the XY plane, it changes the height of one of its points in the Z direction to create a sloped line. """ ## @package gui_lineslope -# \ingroup DRAFT -# \brief Provides tools to change the slope of a line over the working plane. +# \ingroup draftguitools +# \brief Provides GUI tools to change the slope of a line. +## \addtogroup draftguitools +# @{ import PySide.QtGui as QtGui from PySide.QtCore import QT_TRANSLATE_NOOP @@ -39,6 +41,7 @@ import FreeCADGui as Gui import Draft_rc import draftutils.utils as utils import draftguitools.gui_base as gui_base + from draftutils.translate import _tr, translate # The module is used to prevent complaints from code checkers (flake8) @@ -154,3 +157,5 @@ class LineSlope(gui_base.GuiCommandNeedsSelection): Draft_Slope = LineSlope Gui.addCommand('Draft_Slope', LineSlope()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_mirror.py b/src/Mod/Draft/draftguitools/gui_mirror.py index 4e7cc4ec1e..7691a7df66 100644 --- a/src/Mod/Draft/draftguitools/gui_mirror.py +++ b/src/Mod/Draft/draftguitools/gui_mirror.py @@ -22,7 +22,7 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating mirrored objects with the Draft Workbench. +"""Provides GUI tools to create mirrored objects. The mirror tool creates a `Part::Mirroring` object, which is the same as the one created by the Part module. @@ -30,9 +30,11 @@ as the one created by the Part module. Perhaps in the future a specific Draft `Mirror` object can be defined. """ ## @package gui_mirror -# \ingroup DRAFT -# \brief Provides tools for creating mirrored objects with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create mirrored objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App @@ -42,6 +44,7 @@ import DraftVecUtils import WorkingPlane import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils + from draftutils.messages import _msg from draftutils.translate import translate @@ -212,3 +215,5 @@ class Mirror(gui_base_original.Modifier): Gui.addCommand('Draft_Mirror', Mirror()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_move.py b/src/Mod/Draft/draftguitools/gui_move.py index a90cdcd5da..8c7458bb27 100644 --- a/src/Mod/Draft/draftguitools/gui_move.py +++ b/src/Mod/Draft/draftguitools/gui_move.py @@ -22,28 +22,28 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for moving objects in the 3D space.""" +"""Provides GUI tools to move objects in the 3D space.""" ## @package gui_move -# \ingroup DRAFT -# \brief Provides tools for moving objects in the 3D space. +# \ingroup draftguitools +# \brief Provides GUI tools to move objects in the 3D space. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App import FreeCADGui as Gui import Draft_rc import DraftVecUtils - import draftutils.groups as groups import draftutils.todo as todo - import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils import draftguitools.gui_trackers as trackers -from draftguitools.gui_subelements import SubelementHighlight from draftutils.messages import _msg, _err from draftutils.translate import translate +from draftguitools.gui_subelements import SubelementHighlight # The module is used to prevent complaints from code checkers (flake8) True if Draft_rc.__name__ else False @@ -314,3 +314,5 @@ class Move(gui_base_original.Modifier): Gui.addCommand('Draft_Move', Move()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_offset.py b/src/Mod/Draft/draftguitools/gui_offset.py index 401f317fe4..e4249ebadb 100644 --- a/src/Mod/Draft/draftguitools/gui_offset.py +++ b/src/Mod/Draft/draftguitools/gui_offset.py @@ -22,15 +22,17 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for offsetting objects with the Draft Workbench. +"""Provides GUI tools to create offsets from objects. It mostly works on lines, polylines, and similar objects with regular geometrical shapes, like rectangles. """ ## @package gui_offset -# \ingroup DRAFT -# \brief Provides tools for offsetting objects with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create offsets from objects. +## \addtogroup draftguitools +# @{ import math from PySide.QtCore import QT_TRANSLATE_NOOP @@ -42,6 +44,7 @@ import draftutils.utils as utils import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils import draftguitools.gui_trackers as trackers + from draftutils.messages import _msg, _wrn, _err from draftutils.translate import translate, _tr @@ -315,3 +318,5 @@ class Offset(gui_base_original.Modifier): Gui.addCommand('Draft_Offset', Offset()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_orthoarray.py b/src/Mod/Draft/draftguitools/gui_orthoarray.py index e6ae8d824f..19ba415c8c 100644 --- a/src/Mod/Draft/draftguitools/gui_orthoarray.py +++ b/src/Mod/Draft/draftguitools/gui_orthoarray.py @@ -20,11 +20,13 @@ # * USA * # * * # *************************************************************************** -"""Provides the Draft OrthoArray GuiCommand.""" +"""Provides GUI tools to create orthogonal Array objects.""" ## @package gui_orthoarray -# \ingroup DRAFT -# \brief Provides the Draft OrthoArray GuiCommand. +# \ingroup draftguitools +# \brief Provides GUI tools to create orthogonal Array objects. +## \addtogroup draftguitools +# @{ from pivy import coin from PySide.QtCore import QT_TRANSLATE_NOOP @@ -130,3 +132,5 @@ class OrthoArray(gui_base.GuiCommandBase): Gui.addCommand('Draft_OrthoArray', OrthoArray()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_patharray.py b/src/Mod/Draft/draftguitools/gui_patharray.py index 9aa03331ae..9ab06d5405 100644 --- a/src/Mod/Draft/draftguitools/gui_patharray.py +++ b/src/Mod/Draft/draftguitools/gui_patharray.py @@ -25,15 +25,17 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating path arrays with the Draft Workbench. +"""Provides GUI tools to create PathArray objects. The copies will be created along a path, like a polyline, B-spline, or Bezier curve. """ ## @package gui_patharray -# \ingroup DRAFT -# \brief Provides tools for creating path arrays with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create PathArray objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App @@ -183,3 +185,5 @@ class PathLinkArray(PathArray): Gui.addCommand('Draft_PathLinkArray', PathLinkArray()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_planeproxy.py b/src/Mod/Draft/draftguitools/gui_planeproxy.py index 270dd04032..f3df16d97c 100644 --- a/src/Mod/Draft/draftguitools/gui_planeproxy.py +++ b/src/Mod/Draft/draftguitools/gui_planeproxy.py @@ -18,11 +18,13 @@ # * USA * # * * # *************************************************************************** -"""Provides the Draft WorkingPlaneProxy tool.""" +"""Provides GUI tools to create WorkingPlaneProxy objects.""" ## @package gui_planeproxy -# \ingroup DRAFT -# \brief This module provides the Draft WorkingPlaneProxy tool. +# \ingroup draftguitools +# \brief Provides GUI tools to create WorkingPlaneProxy objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App @@ -77,3 +79,5 @@ class Draft_WorkingPlaneProxy: Gui.addCommand('Draft_WorkingPlaneProxy', Draft_WorkingPlaneProxy()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_pointarray.py b/src/Mod/Draft/draftguitools/gui_pointarray.py index cf58e84096..1375226f72 100644 --- a/src/Mod/Draft/draftguitools/gui_pointarray.py +++ b/src/Mod/Draft/draftguitools/gui_pointarray.py @@ -23,7 +23,7 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating point arrays with the Draft Workbench. +"""Provides GUI tools to create PointArray objects. The copies will be created where various points are located. @@ -37,9 +37,11 @@ the explicit point and vertex objects will be used when creating the point array. """ ## @package gui_pointarray -# \ingroup DRAFT -# \brief Provides tools for creating point arrays with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create PointArray objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui @@ -132,3 +134,5 @@ class PointArray(gui_base_original.Modifier): Gui.addCommand('Draft_PointArray', PointArray()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_points.py b/src/Mod/Draft/draftguitools/gui_points.py index 6804bdc568..e6be1e317f 100644 --- a/src/Mod/Draft/draftguitools/gui_points.py +++ b/src/Mod/Draft/draftguitools/gui_points.py @@ -22,7 +22,7 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating simple points with the Draft Workbench. +"""Provides GUI tools to create simple Point objects. A point is just a simple vertex with a position in 3D space. @@ -30,9 +30,11 @@ Its visual properties can be changed, like display size on screen and color. """ ## @package gui_points -# \ingroup DRAFT -# \brief Provides tools for creating simple points with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create simple Point objects. +## \addtogroup draftguitools +# @{ import pivy.coin as coin from PySide.QtCore import QT_TRANSLATE_NOOP @@ -43,6 +45,7 @@ import draftutils.utils as utils import draftutils.gui_utils as gui_utils import draftguitools.gui_base_original as gui_base_original import draftutils.todo as todo + from draftutils.translate import translate, _tr # The module is used to prevent complaints from code checkers (flake8) @@ -161,3 +164,5 @@ class Point(gui_base_original.Creator): Gui.addCommand('Draft_Point', Point()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_polararray.py b/src/Mod/Draft/draftguitools/gui_polararray.py index ae81831374..0e2d465d34 100644 --- a/src/Mod/Draft/draftguitools/gui_polararray.py +++ b/src/Mod/Draft/draftguitools/gui_polararray.py @@ -20,11 +20,13 @@ # * USA * # * * # *************************************************************************** -"""Provides the Draft PolarArray GuiCommand.""" +"""Provides GUI tools to create polar Array objects.""" ## @package gui_polararray -# \ingroup DRAFT -# \brief This module provides the Draft PolarArray tool. +# \ingroup draftguitools +# \brief Provides GUI tools to create polar Array objects. +## \addtogroup draftguitools +# @{ from pivy import coin from PySide.QtCore import QT_TRANSLATE_NOOP @@ -142,3 +144,5 @@ class PolarArray(gui_base.GuiCommandBase): Gui.addCommand('Draft_PolarArray', PolarArray()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_polygons.py b/src/Mod/Draft/draftguitools/gui_polygons.py index 48c4de3435..3011c7cf5b 100644 --- a/src/Mod/Draft/draftguitools/gui_polygons.py +++ b/src/Mod/Draft/draftguitools/gui_polygons.py @@ -22,14 +22,16 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating regular polygons with the Draft Workbench. +"""Provides GUI tools to create regular Polygon objects. Minimum number of sides is three (equilateral triangles). """ ## @package gui_polygons -# \ingroup DRAFT -# \brief Provides tools for creating regular polygons with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create regular Polygon objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App @@ -39,6 +41,7 @@ import draftutils.utils as utils import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils import draftguitools.gui_trackers as trackers + from draftutils.messages import _msg from draftutils.translate import translate @@ -291,3 +294,5 @@ class Polygon(gui_base_original.Creator): Gui.addCommand('Draft_Polygon', Polygon()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_rectangles.py b/src/Mod/Draft/draftguitools/gui_rectangles.py index 39a7213c7f..aff2978189 100644 --- a/src/Mod/Draft/draftguitools/gui_rectangles.py +++ b/src/Mod/Draft/draftguitools/gui_rectangles.py @@ -22,11 +22,13 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating rectangles with the Draft Workbench.""" +"""Provides GUI tools to create Rectangle objects.""" ## @package gui_rectangles -# \ingroup DRAFT -# \brief Provides tools for creating rectangles with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create Rectangle objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App @@ -36,6 +38,7 @@ import draftutils.utils as utils import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils import draftguitools.gui_trackers as trackers + from draftutils.messages import _msg, _err from draftutils.translate import translate @@ -207,3 +210,5 @@ class Rectangle(gui_base_original.Creator): Gui.addCommand('Draft_Rectangle', Rectangle()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_rotate.py b/src/Mod/Draft/draftguitools/gui_rotate.py index 52c19f8725..95286774a1 100644 --- a/src/Mod/Draft/draftguitools/gui_rotate.py +++ b/src/Mod/Draft/draftguitools/gui_rotate.py @@ -22,11 +22,13 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for rotating objects in the 3D space.""" +"""Provides GUI tools to rotate objects in the 3D space.""" ## @package gui_rotate -# \ingroup DRAFT -# \brief Provides tools for rotating objects in the 3D space. +# \ingroup draftguitools +# \brief Provides GUI tools to rotate objects in the 3D space. +## \addtogroup draftguitools +# @{ import math from PySide.QtCore import QT_TRANSLATE_NOOP @@ -34,7 +36,6 @@ import FreeCAD as App import FreeCADGui as Gui import Draft_rc import DraftVecUtils - import draftutils.groups as groups import draftutils.todo as todo import draftguitools.gui_base_original as gui_base_original @@ -429,3 +430,5 @@ class Rotate(gui_base_original.Modifier): Gui.addCommand('Draft_Rotate', Rotate()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_scale.py b/src/Mod/Draft/draftguitools/gui_scale.py index d47b4a69fa..43d02d7d2c 100644 --- a/src/Mod/Draft/draftguitools/gui_scale.py +++ b/src/Mod/Draft/draftguitools/gui_scale.py @@ -22,7 +22,7 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for scaling objects with the Draft Workbench. +"""Provides GUI tools to scale objects in the 3D space. The scale operation can also be done with subelements. @@ -31,16 +31,17 @@ because internally the functions `scaleVertex` and `scaleEdge` only work with polylines that have a `Points` property. """ ## @package gui_scale -# \ingroup DRAFT -# \brief Provides tools for scaling objects with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to scale objects in the 3D space. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App import FreeCADGui as Gui import Draft_rc import DraftVecUtils - import draftutils.utils as utils import draftutils.groups as groups import draftutils.todo as todo @@ -409,3 +410,5 @@ class Scale(gui_base_original.Modifier): Gui.addCommand('Draft_Scale', Scale()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_selectplane.py b/src/Mod/Draft/draftguitools/gui_selectplane.py index 7e35a79268..248c4478c2 100644 --- a/src/Mod/Draft/draftguitools/gui_selectplane.py +++ b/src/Mod/Draft/draftguitools/gui_selectplane.py @@ -18,14 +18,16 @@ # * USA * # * * # *************************************************************************** -"""Provides the Draft SelectPlane tool.""" +"""Provides GUI tools to set up the working plane and its grid.""" ## @package gui_selectplane -# \ingroup DRAFT -# \brief This module provides the Draft SelectPlane tool. +# \ingroup draftguitools +# \brief Provides GUI tools to set up the working plane and its grid. +## \addtogroup draftguitools +# @{ import math -from pivy import coin -from PySide import QtGui +import pivy.coin as coin +import PySide.QtGui as QtGui from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD @@ -34,6 +36,7 @@ import Draft import Draft_rc import DraftVecUtils import drafttaskpanels.task_selectplane as task_selectplane + from draftutils.todo import todo from draftutils.messages import _msg from draftutils.translate import translate @@ -521,3 +524,5 @@ class Draft_SelectPlane: FreeCADGui.addCommand('Draft_SelectPlane', Draft_SelectPlane()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_shape2dview.py b/src/Mod/Draft/draftguitools/gui_shape2dview.py index 5d8be72b38..c1fcc97b15 100644 --- a/src/Mod/Draft/draftguitools/gui_shape2dview.py +++ b/src/Mod/Draft/draftguitools/gui_shape2dview.py @@ -22,16 +22,18 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for projecting objects into a 2D plane. +"""Provides GUI tools to project an object into a 2D plane. This creates a 2D shape in the 3D view itself. This projection can be further used to create a technical drawing using the TechDraw Workbench. """ ## @package gui_shape2dview -# \ingroup DRAFT -# \brief Provides tools for projecting objects into a 2D plane. +# \ingroup draftguitools +# \brief Provides GUI tools to project an object into a 2D plane. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui @@ -39,6 +41,7 @@ import DraftVecUtils import Draft_rc import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils + from draftutils.messages import _msg from draftutils.translate import translate, _tr @@ -121,3 +124,5 @@ class Shape2DView(gui_base_original.Modifier): Gui.addCommand('Draft_Shape2DView', Shape2DView()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_shapestrings.py b/src/Mod/Draft/draftguitools/gui_shapestrings.py index a6f8a5d9e5..2d92c48c97 100644 --- a/src/Mod/Draft/draftguitools/gui_shapestrings.py +++ b/src/Mod/Draft/draftguitools/gui_shapestrings.py @@ -22,7 +22,7 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating text shapes with the Draft Workbench. +"""Provides GUI tools to create text shapes with a particular font. These text shapes are made of various edges and closed faces, and therefore can be extruded to create solid bodies that can be used in boolean @@ -32,9 +32,11 @@ into solid bodies. They are more complex that simple text annotations. """ ## @package gui_shapestrings -# \ingroup DRAFT -# \brief Provides tools for creating text shapes with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create text shapes with a particular font. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import sys @@ -47,6 +49,7 @@ import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils import drafttaskpanels.task_shapestring as task_shapestring import draftutils.todo as todo + from draftutils.translate import translate from draftutils.messages import _msg, _err @@ -230,3 +233,5 @@ class ShapeString(gui_base_original.Creator): Gui.addCommand('Draft_ShapeString', ShapeString()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_snapper.py b/src/Mod/Draft/draftguitools/gui_snapper.py index 8c14d03ef9..b6758ffe7b 100644 --- a/src/Mod/Draft/draftguitools/gui_snapper.py +++ b/src/Mod/Draft/draftguitools/gui_snapper.py @@ -18,7 +18,7 @@ # * USA * # * * # *************************************************************************** -"""Provide the Snapper class to control snapping in the Draft Workbench. +"""Provides the Snapper class to define the snapping tools and modes. This module provides tools to handle point snapping and everything that goes with it (toolbar buttons, cursor icons, etc.). @@ -26,34 +26,33 @@ It also creates the Draft grid, which is actually a tracker defined by `gui_trackers.gridTracker`. """ ## @package gui_snapper -# \ingroup DRAFT -# \brief Snapper class to control snapping in the Draft Workbench. +# \ingroup draftguitools +# \brief Provides the Snapper class to define the snapping tools and modes. # # This module provides tools to handle point snapping and # everything that goes with it (toolbar buttons, cursor icons, etc.). -from pivy import coin -from PySide import QtCore, QtGui - +## \addtogroup draftguitools +# @{ import collections as coll import inspect import itertools import math - -import Draft -import DraftVecUtils -import DraftGeomUtils +import pivy.coin as coin +import PySide.QtCore as QtCore +import PySide.QtGui as QtGui import FreeCAD as App import FreeCADGui as Gui - import Part - +import Draft +import DraftVecUtils +import DraftGeomUtils import draftguitools.gui_trackers as trackers + from draftutils.init_tools import get_draft_snap_commands from draftutils.messages import _msg, _wrn - __title__ = "FreeCAD Draft Snap tools" __author__ = "Yorik van Havre" __url__ = "https://www.freecadweb.org" @@ -1681,3 +1680,5 @@ class Snapper: self.holdTracker.addCoords(self.spoint) self.holdTracker.on() self.holdPoints.append(self.spoint) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_snaps.py b/src/Mod/Draft/draftguitools/gui_snaps.py index f603ddd530..eccd8cafbf 100644 --- a/src/Mod/Draft/draftguitools/gui_snaps.py +++ b/src/Mod/Draft/draftguitools/gui_snaps.py @@ -22,18 +22,19 @@ # * USA * # * * # *************************************************************************** -"""Provide the Draft_Snap commands used by the snapping mechanism in Draft.""" +"""Provides GUI tools to activate the different snapping methods.""" ## @package gui_snaps -# \ingroup DRAFT -# \brief Provide the Draft_Snap commands used by the snapping mechanism -# in Draft. +# \ingroup draftguitools +# \brief Provides GUI tools to activate the different snapping methods. -from PySide import QtGui +## \addtogroup draftguitools +# @{ +import PySide.QtGui as QtGui from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui - import draftguitools.gui_base as gui_base + from draftutils.translate import _tr @@ -625,3 +626,5 @@ class ShowSnapBar(gui_base.GuiCommandSimplest): Gui.addCommand('Draft_ShowSnapBar', ShowSnapBar()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_splines.py b/src/Mod/Draft/draftguitools/gui_splines.py index 0f8f2656a5..925300e9d9 100644 --- a/src/Mod/Draft/draftguitools/gui_splines.py +++ b/src/Mod/Draft/draftguitools/gui_splines.py @@ -22,14 +22,16 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating B-Splines with the Draft Workbench. +"""Provides GUI tools to create BSpline objects. See https://en.wikipedia.org/wiki/B-spline """ ## @package gui_splines -# \ingroup DRAFT -# \brief Provides tools for creating B-Splines with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create BSpline objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui @@ -39,6 +41,7 @@ import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils import draftguitools.gui_lines as gui_lines import draftguitools.gui_trackers as trackers + from draftutils.messages import _msg, _err from draftutils.translate import translate @@ -196,3 +199,5 @@ class BSpline(gui_lines.Line): Gui.addCommand('Draft_BSpline', BSpline()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_split.py b/src/Mod/Draft/draftguitools/gui_split.py index 924e4227ea..880804611e 100644 --- a/src/Mod/Draft/draftguitools/gui_split.py +++ b/src/Mod/Draft/draftguitools/gui_split.py @@ -22,11 +22,13 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for splitting lines with the Draft Workbench.""" +"""Provides GUI tools to split line and wire objects.""" ## @package gui_split -# \ingroup DRAFT -# \brief Provides tools for splitting lines with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to split line and wire objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App @@ -35,6 +37,7 @@ import Draft_rc import DraftVecUtils import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils + from draftutils.messages import _msg from draftutils.translate import translate, _tr @@ -115,3 +118,5 @@ class Split(gui_base_original.Modifier): Gui.addCommand('Draft_Split', Split()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_stretch.py b/src/Mod/Draft/draftguitools/gui_stretch.py index 4f55e28504..3b840bbb6d 100644 --- a/src/Mod/Draft/draftguitools/gui_stretch.py +++ b/src/Mod/Draft/draftguitools/gui_stretch.py @@ -22,7 +22,7 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for stretching objects with the Draft Workbench. +"""Provides GUI tools to stretch Draft objects. It works with rectangles, wires, b-splines, bezier curves, and sketches. It essentially moves the points that are located within a selection area, @@ -30,9 +30,11 @@ while keeping other points intact. This means the lines tied by the points that were moved are 'stretched'. """ ## @package gui_stretch -# \ingroup DRAFT -# \brief Provides tools for stretching objects with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to stretch Draft objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App @@ -43,6 +45,7 @@ import draftutils.utils as utils import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils import draftguitools.gui_trackers as trackers + from draftutils.messages import _msg from draftutils.translate import translate, _tr @@ -483,3 +486,5 @@ class Stretch(gui_base_original.Modifier): Gui.addCommand('Draft_Stretch', Stretch()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_styles.py b/src/Mod/Draft/draftguitools/gui_styles.py index 58fbfc4a3f..d3431986d2 100644 --- a/src/Mod/Draft/draftguitools/gui_styles.py +++ b/src/Mod/Draft/draftguitools/gui_styles.py @@ -22,15 +22,18 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for applying styles to objects in the Draft Workbench.""" +"""Provides GUI tools to apply styles to objects.""" ## @package gui_styles -# \ingroup DRAFT -# \brief Provides tools for applying styles to objects in the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to apply styles to objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui import draftguitools.gui_base_original as gui_base_original + from draftutils.translate import translate, _tr @@ -94,3 +97,5 @@ class ApplyStyle(gui_base_original.Modifier): Gui.addCommand('Draft_ApplyStyle', ApplyStyle()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_subelements.py b/src/Mod/Draft/draftguitools/gui_subelements.py index 3351db2127..0455e6bb85 100644 --- a/src/Mod/Draft/draftguitools/gui_subelements.py +++ b/src/Mod/Draft/draftguitools/gui_subelements.py @@ -22,21 +22,24 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for highlighting subelements in the Draft Workbench. +"""Provides GUI tools to highlight subelements of objects. The highlighting can be used to manipulate shapes with other tools such as Move, Rotate, and Scale. """ ## @package gui_subelements -# \ingroup DRAFT -# \brief Provides tools for highlighting subelements in the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to highlight subelements of objects. +## \addtogroup draftguitools +# @{ import pivy.coin as coin from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils + from draftutils.messages import _msg from draftutils.translate import translate, _tr @@ -159,3 +162,5 @@ class SubelementHighlight(gui_base_original.Modifier): Gui.addCommand('Draft_SubelementHighlight', SubelementHighlight()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_texts.py b/src/Mod/Draft/draftguitools/gui_texts.py index 8d0964e392..4cd0cacaf0 100644 --- a/src/Mod/Draft/draftguitools/gui_texts.py +++ b/src/Mod/Draft/draftguitools/gui_texts.py @@ -22,16 +22,18 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for creating text annotations with the Draft Workbench. +"""Provides GUI tools to create simple Text objects. The textual block can consist of multiple lines. """ ## @package gui_texts -# \ingroup DRAFT -# \brief Provides tools for creating text annotations with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to create simple Text objects. -from PySide.QtCore import QT_TRANSLATE_NOOP +## \addtogroup draftguitools +# @{ import sys +from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCAD as App import FreeCADGui as Gui @@ -157,3 +159,5 @@ class Text(gui_base_original.Creator): Gui.addCommand('Draft_Text', Text()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_togglemodes.py b/src/Mod/Draft/draftguitools/gui_togglemodes.py index 92a3325635..3f87ed1c1c 100644 --- a/src/Mod/Draft/draftguitools/gui_togglemodes.py +++ b/src/Mod/Draft/draftguitools/gui_togglemodes.py @@ -22,19 +22,23 @@ # * USA * # * * # *************************************************************************** -"""Provides tools to control the mode of other tools in the Draft Workbench. +"""Provides GUI tools to set different modes of other tools. For example, a construction mode, a continue mode to repeat commands, and to toggle the appearance of certain shapes to wireframe. """ ## @package gui_togglemodes -# \ingroup DRAFT -# \brief Provides certain mode operations of the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to set different modes of other tools. + +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui import Draft_rc import draftguitools.gui_base as gui_base + from draftutils.messages import _msg from draftutils.translate import _tr @@ -85,7 +89,8 @@ class ToggleConstructionMode(BaseMode): """ def __init__(self): - super(ToggleConstructionMode, self).__init__(name=_tr("Construction mode")) + super(ToggleConstructionMode, + self).__init__(name=_tr("Construction mode")) def GetResources(self): """Set icon, menu and tooltip.""" @@ -166,7 +171,8 @@ class ToggleDisplayMode(gui_base.GuiCommandNeedsSelection): """ def __init__(self): - super(ToggleDisplayMode, self).__init__(name=_tr("Toggle display mode")) + super(ToggleDisplayMode, + self).__init__(name=_tr("Toggle display mode")) def GetResources(self): """Set icon, menu and tooltip.""" @@ -205,3 +211,5 @@ class ToggleDisplayMode(gui_base.GuiCommandNeedsSelection): Gui.addCommand('Draft_ToggleDisplayMode', ToggleDisplayMode()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_tool_utils.py b/src/Mod/Draft/draftguitools/gui_tool_utils.py index c26435a37f..55923ce8c7 100644 --- a/src/Mod/Draft/draftguitools/gui_tool_utils.py +++ b/src/Mod/Draft/draftguitools/gui_tool_utils.py @@ -22,20 +22,23 @@ # * USA * # * * # *************************************************************************** -"""Provides the utility functions for Draft Gui Commands. +"""Provides utility functions that are used by many Draft Gui Commands. These functions are used by different command classes in the `DraftTools` module. We assume that the graphical interface was already loaded as they operate on selections and graphical properties. """ ## @package gui_tool_utils -# \ingroup DRAFT -# \brief Provides the utility functions for Draft Gui Commands. +# \ingroup draftguitools +# \brief Provides utility functions that are used by many Draft Gui Commands. +## \addtogroup draftguitools +# @{ import FreeCAD as App import FreeCADGui as Gui import draftutils.gui_utils as gui_utils import draftutils.utils as utils + from draftutils.messages import _wrn # Set modifier keys from the parameter database @@ -387,3 +390,5 @@ def redraw_3d_view(): redraw3DView = redraw_3d_view + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_trackers.py b/src/Mod/Draft/draftguitools/gui_trackers.py index 9fa0cb08fc..8a8be445dd 100644 --- a/src/Mod/Draft/draftguitools/gui_trackers.py +++ b/src/Mod/Draft/draftguitools/gui_trackers.py @@ -18,29 +18,31 @@ # * USA * # * * # *************************************************************************** -"""Provide Coin based objects used for previews in the Draft Workbench. +"""Provides Coin based objects used to preview objects being built. This module provides Coin (pivy) based objects that are used by the Draft Workbench to draw temporary geometry, that is, previews, of the real objects that will be created on the 3D view. """ -## @package DraftTrackers -# \ingroup DRAFT -# \brief Provide Coin based objects used for previews in the Draft Workbench. +## @package gui_trackers +# \ingroup draftguitools +# \brief Provides Coin based objects used to preview objects being built. # # This module provides Coin (pivy) based objects # that are used by the Draft Workbench to draw temporary geometry, # that is, previews, of the real objects that will be created on the 3D view. -import os +## \addtogroup draftguitools +# @{ import math -from pivy import coin import re +import pivy.coin as coin import FreeCAD import FreeCADGui import Draft import DraftVecUtils + from FreeCAD import Vector from draftutils.todo import ToDo from draftutils.messages import _msg @@ -1317,3 +1319,5 @@ class archDimTracker(Tracker): self.setString() else: return Vector(self.dimnode.pnts.getValues()[-1].getValue()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_trimex.py b/src/Mod/Draft/draftguitools/gui_trimex.py index 7d0e69f89a..3fbd04a1ef 100644 --- a/src/Mod/Draft/draftguitools/gui_trimex.py +++ b/src/Mod/Draft/draftguitools/gui_trimex.py @@ -22,7 +22,7 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for trimming and extending lines with the Draft Workbench. +"""Provides GUI tools to trim and extend lines. It also extends closed faces to create solids, that is, it can be used to extrude a closed profile. @@ -32,9 +32,11 @@ the direction of a line, and up to the distance specified by the snapping point. """ ## @package gui_trimex -# \ingroup DRAFT -# \brief Provides tools for trimming and extending lines. +# \ingroup draftguitools +# \brief Provides GUI tools to trim and extend lines. +## \addtogroup draftguitools +# @{ import math from PySide.QtCore import QT_TRANSLATE_NOOP @@ -48,6 +50,7 @@ import draftutils.gui_utils as gui_utils import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils import draftguitools.gui_trackers as trackers + from draftutils.messages import _msg, _err from draftutils.translate import translate, _tr @@ -569,3 +572,5 @@ class Trimex(gui_base_original.Modifier): Gui.addCommand('Draft_Trimex', Trimex()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_upgrade.py b/src/Mod/Draft/draftguitools/gui_upgrade.py index 7400da0ecd..18acc0cf51 100644 --- a/src/Mod/Draft/draftguitools/gui_upgrade.py +++ b/src/Mod/Draft/draftguitools/gui_upgrade.py @@ -22,21 +22,24 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for upgrading objects with the Draft Workbench. +"""Provides GUI tools to upgrade objects. Upgrades simple 2D objects to more complex objects until it reaches Draft scripted objects. For example, an edge to a wire, and to a Draft Line. """ ## @package gui_upgrade -# \ingroup DRAFT -# \brief Provides tools for upgrading objects with the Draft Workbench. +# \ingroup draftguitools +# \brief Provides GUI tools to upgrade objects. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui import Draft_rc import draftguitools.gui_base_original as gui_base_original import draftguitools.gui_tool_utils as gui_tool_utils + from draftutils.messages import _msg from draftutils.translate import translate, _tr @@ -96,3 +99,5 @@ class Upgrade(gui_base_original.Modifier): Gui.addCommand('Draft_Upgrade', Upgrade()) + +## @} diff --git a/src/Mod/Draft/draftguitools/gui_wire2spline.py b/src/Mod/Draft/draftguitools/gui_wire2spline.py index 63e7fa2cc7..37845ee79d 100644 --- a/src/Mod/Draft/draftguitools/gui_wire2spline.py +++ b/src/Mod/Draft/draftguitools/gui_wire2spline.py @@ -22,7 +22,7 @@ # * USA * # * * # *************************************************************************** -"""Provides tools for converting polylines to B-splines and back. +"""Provides GUI tools to convert polylines to B-splines and back. These tools work on polylines and B-splines which have multiple points. @@ -31,9 +31,11 @@ and passed to the `makeWire` or `makeBSpline` functions, depending on the desired result. """ ## @package gui_wire2spline -# \ingroup DRAFT -# \brief Provides tools for converting polylines to B-splines. +# \ingroup draftguitools +# \brief Provides GUI tools to convert polylines to B-splines and back. +## \addtogroup draftguitools +# @{ from PySide.QtCore import QT_TRANSLATE_NOOP import FreeCADGui as Gui @@ -41,6 +43,7 @@ import Draft_rc import Draft import draftutils.utils as utils import draftguitools.gui_base_original as gui_base_original + from draftutils.translate import translate, _tr # The module is used to prevent complaints from code checkers (flake8) @@ -107,3 +110,5 @@ class WireToBSpline(gui_base_original.Modifier): Gui.addCommand('Draft_WireToBSpline', WireToBSpline()) + +## @}