Draft: add Doxygen strings to the packages' __init__ files
The packages are `draftfunctions`, `draftgeoutils`, `draftguitools`, `draftmake`, `draftobjects`, `drafttaskpanels`, `drafttests`, `draftutils`, `draftviewproviders`.
This commit is contained in:
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user