From 3ccffc1b3fda03e86dd1ba18eea4af6d565fa29d Mon Sep 17 00:00:00 2001 From: vocx-fc Date: Fri, 31 Jan 2020 01:09:46 -0600 Subject: [PATCH] Draft: add README files to explain the new structure --- src/Mod/Draft/draftguitools/README.md | 13 +++++++++++++ src/Mod/Draft/draftobjects/README.md | 7 +++++++ src/Mod/Draft/drafttaskpanels/README.md | 13 +++++++++++++ src/Mod/Draft/draftviewproviders/README.md | 7 +++++++ 4 files changed, 40 insertions(+) create mode 100644 src/Mod/Draft/draftguitools/README.md create mode 100644 src/Mod/Draft/draftobjects/README.md create mode 100644 src/Mod/Draft/drafttaskpanels/README.md create mode 100644 src/Mod/Draft/draftviewproviders/README.md diff --git a/src/Mod/Draft/draftguitools/README.md b/src/Mod/Draft/draftguitools/README.md new file mode 100644 index 000000000000..945a2aa73d5d --- /dev/null +++ b/src/Mod/Draft/draftguitools/README.md @@ -0,0 +1,13 @@ +2020 February + +These files define the GuiCommands, that is, actions called in a graphical +way, either buttons, menu entries, or context commands. + +These tools should be split from the big `DraftTools.py` module. + +These tools are initialized by `InitGui.py`, and require the graphical +interface to exist. + +Those commands that require a "task panel" call the respective module +and class in `drafttaskpanels/`. + diff --git a/src/Mod/Draft/draftobjects/README.md b/src/Mod/Draft/draftobjects/README.md new file mode 100644 index 000000000000..7792a0fd94bc --- /dev/null +++ b/src/Mod/Draft/draftobjects/README.md @@ -0,0 +1,7 @@ +2020 February + +At the moment these object functions aren't used. + +When the Draft tools are eventually split into individual modules, +the code of the object creation functions should be placed here. + diff --git a/src/Mod/Draft/drafttaskpanels/README.md b/src/Mod/Draft/drafttaskpanels/README.md new file mode 100644 index 000000000000..ea1b29a3e775 --- /dev/null +++ b/src/Mod/Draft/drafttaskpanels/README.md @@ -0,0 +1,13 @@ +2020 February + +These files provide the logic behind the task panel of the GuiCommands +defined in `draftguitools/`. + +The task panel graphical interface is properly defined in +the `Resources/ui/` files, which are made with QtCreator. + +There are many commands which aren't defined in `draftguitools/`. +These are defined in the big `DraftGui.py` module, which needs to be split +into individual GuiCommands, and each should have its own dedicated +`.ui` file. + diff --git a/src/Mod/Draft/draftviewproviders/README.md b/src/Mod/Draft/draftviewproviders/README.md new file mode 100644 index 000000000000..cbdeb192721d --- /dev/null +++ b/src/Mod/Draft/draftviewproviders/README.md @@ -0,0 +1,7 @@ +2020 February + +At the moment these view providers aren't used at all. + +When the Draft tools are eventually split into individual modules, +the code of the view providers should be placed here. +