Commit Graph

9 Commits

Author SHA1 Message Date
Robin Müller e952a82b65
small tweaks and fixes 2021-12-07 13:14:57 +01:00
Robin Müller cbcfa8fe56 Merge remote-tracking branch 'upstream/development' into mueller/clang-shell-script 2021-12-06 15:06:05 +01:00
Robin Müller 4a5204d6f6
small fix for helper script 2021-12-06 14:46:31 +01:00
Robin Müller df45f02c39
script fixes, odd behaviour 2021-12-03 14:55:00 +01:00
Robin Müller fd7581f8ba Added formatting scripts
1. Added .clang-format file which contains information for the
   clang-format tool on how to format source files
2. Added shell helper script to apply all changes on HAL soures,
   test sources and primary sources

The shell script was not applied yet. This should be done shortly
before introducing the release. Also, it might be good idea to provide
instructions on how to set up the formatter for Eclipse
2021-12-01 16:11:57 +01:00
Robin Müller c2bf09d506 Introducing documentation with Sphinx
This PR introduces the generation of documentation based on
this excellent blog post: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

It combines the tools Sphinx, Doxygen and Breathe to generate good
looking HTML documentation conveniently which can be hosted easily.

The helper scripts were unified and there is now one helper.py script
which can be used to create, build and open both tests and documentation.
"./helper.py -h" can be used to get the different options.

This PR also contains some smaller fixes which were necessary for the docs
to build
2021-12-01 11:17:28 +01:00
Robin Müller 00dced31ee
update unittest helper scripts
- Added functionality to open HTML report immediately
- Added another helper script to automatically generate unittest build
  folder
2021-11-19 13:50:46 +01:00
Robin Müller 1b6fa9822b
this should work 2021-10-11 15:40:29 +02:00
Robin Müller ade15ad16d
tests can now be built as part of FSFW
This PR refactores the tests so they are built as part of the FSFW.
This is done by adding Catch2 with the FetchContent directive.

A future implementation might also use a system installation of Catch2
by first checking whether Catch2 can already be found as a package

The custom configuration folder testcfg was moved from the user folder
to the actual unittest folder.

The tests can be built by setting the CMake FSFW_BUILD_UNITTESTS option
to TRUE/ON. They are built with the static library and dropped inside
the build folders fsfw directory.
2021-10-07 13:24:46 +02:00