Draft: add modules of draftgeoutils to the proper Doxygen group

This includes `arcs`, `circle_inversion`, `circles`, `circles_apollonius`,
`circles_incomplete`, `cuboids`, `edges`, `faces`, `fillets`,
`general`, `geometry`, `intersections`, `linear_geometry`,
`offsets`, `sort_edges`, `wires`.

These are added to the `draftgeoutils` Doxygen group so that
the functions contained in each module are listed appropriately
in the automatically generated documentation.
This commit is contained in:
vocx-fc
2020-06-29 18:55:28 -05:00
committed by Yorik van Havre
parent a1ce2389d3
commit b434761e35
16 changed files with 119 additions and 43 deletions

View File

@@ -21,10 +21,10 @@
# * USA *
# * *
# ***************************************************************************
"""Provides basic functions for calculating intersections of shapes."""
"""Provides various functions to calculate intersections of shapes."""
## @package intersections
# \ingroup DRAFTGEOUTILS
# \brief Provides basic functions for calculating intersections of shapes.
# \ingroup draftgeoutils
# \brief Provides various functions to calculate intersections of shapes.
import lazy_loader.lazy_loader as lz
@@ -37,6 +37,9 @@ from draftgeoutils.edges import findMidpoint
# Delay import of module until first use because it is heavy
Part = lz.LazyLoader("Part", globals(), "Part")
## \addtogroup draftgeoutils
# @{
def findIntersection(edge1, edge2,
infinite1=False, infinite2=False,
@@ -411,3 +414,5 @@ def angleBisection(edge1, edge2):
direction.normalize()
return Part.LineSegment(origin, origin.add(direction)).toShape()
## @}