Skip to content

Commit 78ed435

Browse files
authored
Merge pull request #22 from dirkolbrich/master
add code fence for better source tree display
2 parents ea0bf51 + 15d537d commit 78ed435

File tree

1 file changed

+42
-44
lines changed

1 file changed

+42
-44
lines changed

technical/ChecklistForNewFeatureC++.md

Lines changed: 42 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The module code is divided into an App portion that deals with the document and
1010
its objects and a Gui portion that deals with visual aspects. Our source tree looks
1111
like this:
1212

13-
13+
```txt
1414
FreeCAD/src
1515
Mod
1616
myModule
@@ -31,59 +31,57 @@ FreeCAD/src
3131
TaskmyFeature.cpp
3232
TaskmyFeature.h
3333
TaskmyFeature.ui
34-
34+
```
3535

3636
## App changes
3737

38-
* new myModule/App/myFeature.cpp
39-
* new myModule/App/myFeature.h
40-
* new myModule/App/myFeaturePy.xml
41-
* new myModule/App/myFeaturePyImp.cpp
38+
- new myModule/App/myFeature.cpp
39+
- new myModule/App/myFeature.h
40+
- new myModule/App/myFeaturePy.xml
41+
- new myModule/App/myFeaturePyImp.cpp
4242

43-
* edit myModule/App/CMakeLists.txt
44-
** add new source files
45-
* edit myModule/App/AppmyModule.cpp
46-
** add include(s) for new objects
47-
** add init calls for new objects
43+
- edit myModule/App/CMakeLists.txt
44+
+ add new source files
45+
- edit myModule/App/AppmyModule.cpp
46+
+ add include(s) for new objects
47+
+ add init calls for new objects
4848

4949
## Gui changes
5050

51-
* new myModule/Gui/ViewProvidermyFeature.cpp
52-
* new myModule/Gui/ViewProvidermyFeature.h
53-
* new myModule/Gui/TaskmyFeature.cpp
54-
* new myModule/Gui/TaskmyFeature.h
55-
* new myModule/Gui/TaskmyFeature.ui
56-
57-
* edit myModule/Gui/CMakeLists.txt
58-
** add new source files
59-
* edit myModule/Gui/AppmyModuleGui.cpp
60-
** add includes for new objects
61-
** add init calls for new objects
62-
* edit myModule/Gui/CommandXXXX.cpp
63-
** add new command
64-
* edit myModule/Gui/Workbench.cpp
65-
** add new command to menu & toolbar
66-
67-
* new myModule/Gui/Resources/icons/myModule_myFeature.svg
68-
* edit myModule/Gui/Resources/myModule.qrc
69-
** add icon to list
51+
- new myModule/Gui/ViewProvidermyFeature.cpp
52+
- new myModule/Gui/ViewProvidermyFeature.h
53+
- new myModule/Gui/TaskmyFeature.cpp
54+
- new myModule/Gui/TaskmyFeature.h
55+
- new myModule/Gui/TaskmyFeature.ui
56+
57+
- edit myModule/Gui/CMakeLists.txt
58+
+ add new source files
59+
- edit myModule/Gui/AppmyModuleGui.cpp
60+
+ add includes for new objects
61+
+ add init calls for new objects
62+
- edit myModule/Gui/CommandXXXX.cpp
63+
+ add new command
64+
- edit myModule/Gui/Workbench.cpp
65+
+ add new command to menu & toolbar
66+
67+
- new myModule/Gui/Resources/icons/myModule_myFeature.svg
68+
- edit myModule/Gui/Resources/myModule.qrc
69+
+ add icon to list
7070

7171
## Test changes
7272

73-
* new test script myModule/myModuleTest/myFeatureTest.py
74-
* edit myModule/myModuleTest/TestmyModuleApp.py and/or myModule/myModuleTest/TestmyModuleGui.py
75-
** add import for myFeatureTest
76-
* edit myModule/CMakeLists.txt
77-
** add myFeatureTest.py to list
78-
* new unit tests
79-
** ????
73+
- new test script myModule/myModuleTest/myFeatureTest.py
74+
- edit myModule/myModuleTest/TestmyModuleApp.py _and/or_ myModule/myModuleTest/TestmyModuleGui.py
75+
+ add import for myFeatureTest
76+
- edit myModule/CMakeLists.txt
77+
+ add myFeatureTest.py to list
78+
- new unit tests
79+
+ ????
8080

8181
## Documentation changes
8282

83-
* new wiki.freecad.org/myModule_myFeature
84-
* edit wiki.freecad.org/myModule_Workbench
85-
** add new entry in module overview
86-
* edit predecessor and successor wiki entries
87-
** update next and previous article pointers
88-
89-
83+
- new wiki.freecad.org/myModule_myFeature
84+
- edit wiki.freecad.org/myModule_Workbench
85+
+ add new entry in module overview
86+
- edit predecessor and successor wiki entries
87+
+ update next and previous article pointers

0 commit comments

Comments
 (0)