From 91a23e4a40bc9dd429cc2f0d90c938001fdebfd2 Mon Sep 17 00:00:00 2001 From: vocx-fc Date: Wed, 3 Jun 2020 18:56:31 -0500 Subject: [PATCH] Draft: add Doxygen strings to the packages' __init__ files The packages are `draftfunctions`, `draftgeoutils`, `draftguitools`, `draftmake`, `draftobjects`, `drafttaskpanels`, `drafttests`, `draftutils`, `draftviewproviders`. --- src/Mod/Draft/draftfunctions/__init__.py | 3 +++ src/Mod/Draft/draftgeoutils/__init__.py | 3 +++ src/Mod/Draft/draftguitools/__init__.py | 3 +++ src/Mod/Draft/draftmake/__init__.py | 3 +++ src/Mod/Draft/draftobjects/__init__.py | 3 +++ src/Mod/Draft/drafttaskpanels/__init__.py | 3 +++ src/Mod/Draft/drafttests/__init__.py | 3 +++ src/Mod/Draft/draftutils/__init__.py | 3 +++ src/Mod/Draft/draftviewproviders/__init__.py | 3 +++ 9 files changed, 27 insertions(+) diff --git a/src/Mod/Draft/draftfunctions/__init__.py b/src/Mod/Draft/draftfunctions/__init__.py index a36bc56577..be5404eac0 100644 --- a/src/Mod/Draft/draftfunctions/__init__.py +++ b/src/Mod/Draft/draftfunctions/__init__.py @@ -39,3 +39,6 @@ represent the public application programming interface (API) of the Draft Workbench, and should be made available in the `Draft` namespace by importing them in the `Draft` module. """ +## \defgroup draftfuctions draftfuctions +# \ingroup DRAFT +# \brief Modules with functions for use with scripted objects and GuiCommands. diff --git a/src/Mod/Draft/draftgeoutils/__init__.py b/src/Mod/Draft/draftgeoutils/__init__.py index 3dbd9f9f52..f83af33ba3 100644 --- a/src/Mod/Draft/draftgeoutils/__init__.py +++ b/src/Mod/Draft/draftgeoutils/__init__.py @@ -38,3 +38,6 @@ part of the Draft workbench programming interface yet. These functions were previously defined in the big `DraftGeomUtils` module. """ +## \defgroup draftgeoutils draftgeoutils +# \ingroup DRAFT +# \brief Functions that are meant to handle different geometrical operations diff --git a/src/Mod/Draft/draftguitools/__init__.py b/src/Mod/Draft/draftguitools/__init__.py index d946cb3c00..a269186771 100644 --- a/src/Mod/Draft/draftguitools/__init__.py +++ b/src/Mod/Draft/draftguitools/__init__.py @@ -63,3 +63,6 @@ namespaces, so they are accessible at all times. These classes can be imported and initialized individually but it is easier to set them up just by importing `DraftTools`. """ +## \defgroup draftguitools draftguitools +# \ingroup DRAFT +# \brief Modules that define the workbench GuiCommands to perform actions. diff --git a/src/Mod/Draft/draftmake/__init__.py b/src/Mod/Draft/draftmake/__init__.py index feb8533719..23d8a00351 100644 --- a/src/Mod/Draft/draftmake/__init__.py +++ b/src/Mod/Draft/draftmake/__init__.py @@ -80,3 +80,6 @@ can have other properties like `App::PropertyPlacement`, or which can interact with the 3D view through Coin, can be based on the simple `App::FeaturePython` object. """ +## \defgroup draftmake draftmake +# \ingroup DRAFT +# \brief Modules with functions to create the custom scripted objects. diff --git a/src/Mod/Draft/draftobjects/__init__.py b/src/Mod/Draft/draftobjects/__init__.py index d273235673..62b0f3b908 100644 --- a/src/Mod/Draft/draftobjects/__init__.py +++ b/src/Mod/Draft/draftobjects/__init__.py @@ -53,3 +53,6 @@ as the older class. old_module.Rectangle = new_module.Rectangle """ +## \defgroup draftobjects draftobjects +# \ingroup DRAFT +# \brief Modules that contain classes that define custom scripted objects. diff --git a/src/Mod/Draft/drafttaskpanels/__init__.py b/src/Mod/Draft/drafttaskpanels/__init__.py index 99af4cf612..33a31b7a51 100644 --- a/src/Mod/Draft/drafttaskpanels/__init__.py +++ b/src/Mod/Draft/drafttaskpanels/__init__.py @@ -53,3 +53,6 @@ Individual task panel classes and `.ui` files are more maintainable because changes can be done to a single tool without affecting the rest, and the module size is kept small. """ +## \defgroup drafttaskpanels drafttaskpanels +# \ingroup DRAFT +# \brief Modules with classes that handle task panels of the GuiCommands. diff --git a/src/Mod/Draft/drafttests/__init__.py b/src/Mod/Draft/drafttests/__init__.py index 7abb26deaa..5977e30dae 100644 --- a/src/Mod/Draft/drafttests/__init__.py +++ b/src/Mod/Draft/drafttests/__init__.py @@ -39,3 +39,6 @@ on how to write unit tests. def test_new_tool(self): pass """ +## \defgroup drafttests drafttests +# \ingroup DRAFT +# \brief Modules that define classes used for unit testing the workbench. diff --git a/src/Mod/Draft/draftutils/__init__.py b/src/Mod/Draft/draftutils/__init__.py index 321fb0d901..84b40cfd2f 100644 --- a/src/Mod/Draft/draftutils/__init__.py +++ b/src/Mod/Draft/draftutils/__init__.py @@ -48,3 +48,6 @@ Initialization modules for the GUI - `init_tools`, initialize toolbars and menus of the workbench - `init_draft_statusbar`, initialize the status bar of the workbench """ +## \defgroup draftutils draftutils +# \ingroup DRAFT +# \brief Utility modules that are used throughout the workbench. diff --git a/src/Mod/Draft/draftviewproviders/__init__.py b/src/Mod/Draft/draftviewproviders/__init__.py index fe9e7da55c..d6efe58d07 100644 --- a/src/Mod/Draft/draftviewproviders/__init__.py +++ b/src/Mod/Draft/draftviewproviders/__init__.py @@ -54,3 +54,6 @@ as the older class. old_module.ViewProviderRectangle = new_module.ViewProviderRectangle """ +## \defgroup draftviewproviders draftviewproviders +# \ingroup DRAFT +# \brief Classes that define viewproviders for the scripted objects.