Draft: add modules of draftutils to the proper Doxygen group

This includes `gui_utils`, `init_draft_statusbar`, `init_tools`,
`messages`, `todo`, `translate`, `utils`.

These are added to the `draftutils` 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-07-01 13:25:18 -05:00
committed by Yorik van Havre
parent e853503907
commit dd70caa723
9 changed files with 93 additions and 55 deletions

View File

@@ -20,7 +20,7 @@
# * USA *
# * *
# ***************************************************************************
"""Provide message utility functions for the Draft Workbench.
"""Provides utility functions that wrap around the Console methods.
The Console module has long function names, so we define some shorthands
that are suitable for use in every workbench. These shorthands also include
@@ -28,27 +28,31 @@ a newline character at the end of the string, so it doesn't have to be
added manually.
"""
## @package messages
# \ingroup DRAFT
# \brief Provide message utility functions for the Draft Workbench.
# \ingroup draftutils
# \brief Provides utility functions that wrap around the Console methods.
## \addtogroup draftutils
# @{
import FreeCAD as App
def _msg(text, end="\n"):
"""Write messages to console including the line ending."""
"""Write messages to the console including the line ending."""
App.Console.PrintMessage(text + end)
def _wrn(text, end="\n"):
"""Write warnings to console including the line ending."""
"""Write warnings to the console including the line ending."""
App.Console.PrintWarning(text + end)
def _err(text, end="\n"):
"""Write errors to console including the line ending."""
"""Write errors to the console including the line ending."""
App.Console.PrintError(text + end)
def _log(text, end="\n"):
"""Write messages to the log file including the line ending."""
App.Console.PrintLog(text + end)
## @}