Commit Graph

4517 Commits

Author SHA1 Message Date
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
bf31248a50 Merge pull request 'Update SerializeAdapter' (#513) from KSat/fsfw:mueller/serializeif-update into development
Reviewed-on: fsfw/fsfw#513
2021-11-29 14:37:40 +01:00
9fadc9b830 Merge branch 'development' into mueller/serializeif-update 2021-11-29 14:36:25 +01:00
8c17c7e1a7 Merge pull request 'update unittest helper scripts' (#525) from eive/fsfw:mueller/update-scripts into development
Reviewed-on: fsfw/fsfw#525
2021-11-29 14:35:07 +01:00
9c5e3565c6 Merge branch 'development' into mueller/serializeif-update 2021-11-24 18:53:28 +01:00
ecc7f1d691 Merge branch 'development' into mueller/update-scripts 2021-11-24 13:13:26 +01:00
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
ab7117d81e Merge pull request 'Bugfix for Packet ID getters' (#524) from eive/fsfw:mueller/bugfix-improvements-packet-id-functions into development
Reviewed-on: fsfw/fsfw#524
2021-11-19 13:46:46 +01:00
05c4f4fadc
Bugfix for Packet ID getters
- Also added related unittests
2021-11-18 19:56:24 +01:00
186b3565e0 Merge pull request 'Unittests for Op Divider and Bitutility' (#510) from KSat/fsfw:mueller/unittests-op-divider-bitutil into development
Reviewed-on: fsfw/fsfw#510
2021-11-15 14:24:15 +01:00
e688105073 Merge branch 'development' into mueller/unittests-op-divider-bitutil 2021-11-15 14:23:34 +01:00
f7c6ec329b Merge pull request 'Filesystem Base Interface: Use IF instead of void pointer' (#511) from KSat/fsfw:mueller/filesystem-api-update into development
Reviewed-on: fsfw/fsfw#511
2021-11-15 14:23:04 +01:00
30217aa42b
updated SerializeAdapter.h
- Updates `SerializerAdapter` to also take simple pointer and simply assign the serialized and deSerialized size
- Added related unittests
2021-11-10 18:51:56 +01:00
0176c07886
use IF instead of void pointer 2021-11-10 18:49:29 +01:00
6d5eb5b387
Op Divider and bitutility updates
- Added unittests for `PeriodicOperationDivider` and the `bitutil` helpers
- Some API changes: Removed redundant bit part, because these functions are already in a namespace
- Some bugfixes for `PeriodicOperationDivider`
2021-11-10 18:48:02 +01:00
9a38106b57 Merge pull request 'STM32 SPI Updates' (#518) from mueller/stm32-spi-updates into development
Reviewed-on: fsfw/fsfw#518
2021-11-08 14:52:28 +01:00
75e16e0b7b Merge branch 'development' into mueller/stm32-spi-updates 2021-11-08 14:51:02 +01:00
87a15910fe Merge pull request 'CMakeLists fixes' (#517) from mueller/cmake-fixes into development
Reviewed-on: fsfw/fsfw#517

LGTM
2021-11-08 14:44:39 +01:00
9ad215c9a3 Merge branch 'development' into mueller/cmake-fixes 2021-10-28 09:20:02 +02:00
2ca7a84e86 Merge branch 'development' into mueller/stm32-spi-updates 2021-10-28 09:19:31 +02:00
fbeb578d1c Merge pull request 'introducing valgrind' (#521) from mohr_ci into development
Reviewed-on: fsfw/fsfw#521
2021-10-27 21:49:57 +02:00
58d4525e8a Merge branch 'development' into mohr_ci 2021-10-27 21:35:17 +02:00
8d004e9621 Merge pull request 'Out of bound reads and writes in unittests' (#519) from mohr_valgrind into development
Reviewed-on: fsfw/fsfw#519
2021-10-27 21:35:01 +02:00
a53992fdc9 introducing valgrind 2021-10-27 21:32:40 +02:00
c6bbc19b85 Merge pull request 'Adding code for CI with docker and jenkins' (#520) from mohr_ci into development
Reviewed-on: fsfw/fsfw#520
2021-10-27 20:52:57 +02:00
36aaf3d758 say hi to my new friend valgrind 2021-10-27 20:41:04 +02:00
7c855592d0 more cleaning up 2021-10-27 18:12:56 +02:00
cb7399b999 msp init improvements 2021-10-27 18:12:46 +02:00
d675621b73 grouping CS gpio definition 2021-10-27 17:32:21 +02:00
3448a8c01b SPI ComIF updates
1. Make setting a chip select pin optional
2. Make ComIF member functions public
2021-10-27 17:32:13 +02:00
42458725e8
more important fix 2021-10-27 17:10:37 +02:00
cc7250fcf5
second cmake fix 2021-10-27 17:08:59 +02:00
da42edcc0c Jenkinsfile: added stage to be more verbose 2021-10-26 20:58:34 +02:00
b02f737418 jenkins cosmetics 2021-10-26 20:53:08 +02:00
1923b339e9 I can not jenkins 2021-10-26 20:47:53 +02:00
3c41472649 tweaking Jenkinsfile 2021-10-26 20:30:22 +02:00
da19764232 Merge pull request 'Unittest and Integration test hotfix' (#516) from KSat/fsfw:mueller/unittest-hotfix into development
Reviewed-on: fsfw/fsfw#516
2021-10-26 17:36:40 +02:00
2126e6e375 simplified test task 2021-10-26 17:24:47 +02:00
5f8adc63b7
some more fixes for integration tests 2021-10-26 17:16:21 +02:00
81bae85825 hotfix for unittests 2021-10-26 17:10:54 +02:00
e263f2fbdc Merge pull request 'added integration test code' (#508) from mueller/example-code-as-test into development
Reviewed-on: fsfw/fsfw#508
2021-10-25 15:30:53 +02:00
8d34561137 Merge branch 'development' into mueller/example-code-as-test 2021-10-25 15:06:36 +02:00
19f9b0280c added jenkins integration 2021-10-25 14:59:16 +02:00
e86319707f Merge branch 'development' into mueller/example-code-as-test 2021-10-25 14:52:43 +02:00
0e653378c3 Merge pull request 'Arrayprinter format improvements' (#514) from KSat/fsfw:mueller/arrayprinter-improvements into development
Reviewed-on: fsfw/fsfw#514
2021-10-25 14:09:25 +02:00
a506b94d7e Merge branch 'development' into mueller/arrayprinter-improvements 2021-10-25 14:09:08 +02:00
7bff632042 Merge pull request 'updated function names' (#509) from eive/fsfw:mueller/constexpr-func-name into development
Reviewed-on: fsfw/fsfw#509
2021-10-25 14:05:14 +02:00
07a0dd5331
this is the correct file 2021-10-22 11:32:28 +02:00
f16dcebf6b Merge branch 'development' into mueller/arrayprinter-improvements 2021-10-22 11:31:57 +02:00
dc6ed40bfb
arrayprinter format improvements 2021-10-22 11:30:00 +02:00