You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Update MathComponent to Reference TestMain (#1030)
* docs: MathComponent References TestMain
The existing MathComponent tutorial references a `main.cpp` test file
that has been replaced by an autogenerated TestMain.cpp file. The
docs have been updated to reference the TestMain file instead of
the old manually created main.cpp file.
* lestarch: updating docs to clarify *Base.* files being autocoded.
Co-authored-by: M Starch <[email protected]>
Copy file name to clipboardExpand all lines: docs/Tutorials/MathComponent/Tutorial.md
+17-14Lines changed: 17 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1085,19 +1085,19 @@ The files that are generated are:
1085
1085
```
1086
1086
Tester.hpp
1087
1087
Tester.cpp
1088
-
TesterBase.hpp
1089
-
TesterBase.cpp
1090
-
GTestBase.hpp
1091
-
GTestBase.cpp
1088
+
TestMain.cpp
1092
1089
```
1093
1090
1091
+
**Note:** TesterBase.* and GTestBase.* files can be removed. these will be regenerated when the unit test builds.
1092
+
1094
1093
The functions of the files are:
1095
1094
1096
1095
|File|Function|
1097
1096
|---|---|
1098
-
|TesterBase.*|Base class for test class. Defines necessary handlers as well as helper functions
1099
-
|GTestBase.*|Helper class derived from TesterBase that has macros that use Google Test to test interfaces|
1097
+
|TesterBase.*|Base class for test class. Defines necessary handlers as well as helper functions. **Autocoded**|
1098
+
|GTestBase.*|Helper class derived from TesterBase that has macros that use Google Test to test interfaces. **Autocoded**|
1100
1099
|Tester.*|Derived tester class that inherits from GTestBase. Includes instance of the component and helpers to connect ports|
1100
+
|TestMain.cpp|Main unit test implementation file|
1101
1101
1102
1102
Unit tests are built in subdirectories of the module, so the unit test file must be copied there. The build system supports a standard subdirectory of `test/ut` below the module being tested. While in the MathSender directory, create the `test/ut` directory:
0 commit comments