Draft: fix doxygen typos
This commit is contained in:
@@ -39,6 +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
|
||||
## \defgroup draftfunctions draftfunctions
|
||||
# \ingroup DRAFT
|
||||
# \brief Modules with functions for use with scripted objects and GuiCommands.
|
||||
|
||||
@@ -24,10 +24,10 @@
|
||||
# ***************************************************************************
|
||||
"""Provides functions to create non-parametric arrayed copies."""
|
||||
## @package array
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to create non-parametric arrayed copies.
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
import FreeCAD as App
|
||||
import draftutils.utils as utils
|
||||
|
||||
@@ -22,10 +22,10 @@
|
||||
# ***************************************************************************
|
||||
"""Provides functions to create a cut object from two objects."""
|
||||
## @package cut
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to create a cut object from two objects.
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
import FreeCAD as App
|
||||
import draftutils.gui_utils as gui_utils
|
||||
|
||||
@@ -25,10 +25,10 @@
|
||||
See also the `upgrade` function.
|
||||
"""
|
||||
## @package downgrade
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to downgrade objects by different methods.
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
import FreeCAD as App
|
||||
import draftutils.utils as utils
|
||||
|
||||
@@ -22,10 +22,10 @@
|
||||
# ***************************************************************************
|
||||
"""Provides functions to transform sketches into Draft objects."""
|
||||
## @package draftify
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to transform sketches into Draft objects.
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
|
||||
import lazy_loader.lazy_loader as lz
|
||||
|
||||
@@ -28,7 +28,7 @@ Therefore, even if the Drawing Workbench is obsolete, the `Drawing` module
|
||||
may not be removed completely yet. This must be checked.
|
||||
"""
|
||||
## @package dxf
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to return the DXF representation of shapes.
|
||||
|
||||
import lazy_loader.lazy_loader as lz
|
||||
@@ -46,7 +46,7 @@ DraftGeomUtils = lz.LazyLoader("DraftGeomUtils", globals(), "DraftGeomUtils")
|
||||
Drawing = lz.LazyLoader("Drawing", globals(), "Drawing")
|
||||
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
|
||||
def _get_proj(vec, plane=None):
|
||||
|
||||
@@ -22,10 +22,10 @@
|
||||
# ***************************************************************************
|
||||
"""Provides functions to create an extrusion object from a profile."""
|
||||
## @package extrude
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to create an extrusion object from a profile.
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
import FreeCAD as App
|
||||
import draftutils.gui_utils as gui_utils
|
||||
|
||||
@@ -22,10 +22,10 @@
|
||||
# ***************************************************************************
|
||||
"""Provides functions to create a fusion of two shapes."""
|
||||
## @package fuse
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to create a fusion of two shapes.
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
import FreeCAD as App
|
||||
import draftutils.gui_utils as gui_utils
|
||||
|
||||
@@ -22,10 +22,10 @@
|
||||
# ***************************************************************************
|
||||
"""Provides functions to repair certain objects created with old versions."""
|
||||
## @package heal
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to repair certain objects from old versions.
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
import FreeCAD as App
|
||||
import draftutils.utils as utils
|
||||
|
||||
@@ -22,10 +22,10 @@
|
||||
# ***************************************************************************
|
||||
"""Provides functions to join wires together into a single wire."""
|
||||
## @package join
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to join wires together into a single wire.
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
import FreeCAD as App
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ It just creates a `Part::Mirroring` object, and sets the appropriate
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to produce a mirrored object.
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
import FreeCAD as App
|
||||
import draftutils.utils as utils
|
||||
|
||||
@@ -22,10 +22,10 @@
|
||||
# ***************************************************************************
|
||||
"""Provides functions to move objects from one position to another."""
|
||||
## @package move
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to move objects from one position to another.
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
import FreeCAD as App
|
||||
import draftutils.utils as utils
|
||||
|
||||
@@ -22,10 +22,10 @@
|
||||
# ***************************************************************************
|
||||
"""Provides functions to create offsets of different shapes."""
|
||||
## @package offset
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to create offsets of different shapes.
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
import math
|
||||
|
||||
|
||||
@@ -22,10 +22,10 @@
|
||||
# ***************************************************************************
|
||||
"""Provides functions to rotate shapes around a center and axis."""
|
||||
## @package rotate
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to rotate shapes around a center and axis.
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
import math
|
||||
|
||||
|
||||
@@ -22,10 +22,10 @@
|
||||
# ***************************************************************************
|
||||
"""Provides functions to scale shapes."""
|
||||
## @package scale
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to scale shapes.
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
import FreeCAD as App
|
||||
import DraftVecUtils
|
||||
|
||||
@@ -22,10 +22,10 @@
|
||||
# ***************************************************************************
|
||||
"""Provides functions to split wires into separate wire objects."""
|
||||
## @package split
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to split wires into separate wire objects.
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
import draftutils.utils as utils
|
||||
import draftmake.make_wire as make_wire
|
||||
|
||||
@@ -29,7 +29,7 @@ Therefore, even if the Drawing Workbench is obsolete, the `Drawing` module
|
||||
may not be removed completely yet. This must be checked.
|
||||
"""
|
||||
## @package svg
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to return the SVG representation of shapes.
|
||||
|
||||
import math
|
||||
@@ -51,7 +51,7 @@ DraftGeomUtils = lz.LazyLoader("DraftGeomUtils", globals(), "DraftGeomUtils")
|
||||
# Drawing = lz.LazyLoader("Drawing", globals(), "Drawing")
|
||||
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ Therefore, even if the Drawing Workbench is obsolete, the `Drawing` module
|
||||
may not be removed completely yet. This must be checked.
|
||||
"""
|
||||
## @package svgshapes
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to return the SVG representation of some shapes.
|
||||
|
||||
import math
|
||||
@@ -47,7 +47,7 @@ Part = lz.LazyLoader("Part", globals(), "Part")
|
||||
DraftGeomUtils = lz.LazyLoader("DraftGeomUtils", globals(), "DraftGeomUtils")
|
||||
Drawing = lz.LazyLoader("Drawing", globals(), "Drawing")
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
# ***************************************************************************
|
||||
"""Provides functions to return the SVG representation of text elements."""
|
||||
## @package svgtext
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to return the SVG representation of text elements.
|
||||
|
||||
import math
|
||||
@@ -32,7 +32,7 @@ import six
|
||||
import FreeCAD as App
|
||||
import draftutils.utils as utils
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
See also the `downgrade` function.
|
||||
"""
|
||||
## @package downgrade
|
||||
# \ingroup draftfuctions
|
||||
# \ingroup draftfunctions
|
||||
# \brief Provides functions to upgrade objects by different methods.
|
||||
|
||||
import re
|
||||
@@ -51,7 +51,7 @@ Arch = lz.LazyLoader("Arch", globals(), "Arch")
|
||||
|
||||
_DEBUG = False
|
||||
|
||||
## \addtogroup draftfuctions
|
||||
## \addtogroup draftfunctions
|
||||
# @{
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user