Skip to content

Commit

Permalink
Merge pull request #208 from xkevin190/add_docs_to_tests
Browse files Browse the repository at this point in the history
added doc.txt to ds18_sensor test
  • Loading branch information
luisan00 authored Apr 4, 2022
2 parents 1013530 + 41c1df0 commit c606daa
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 31 deletions.
30 changes: 30 additions & 0 deletions tests/ds18/doc.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/**
@defgroup ds18_test Ds18 sensor test module
@ingroup test_group
@{


## Test DS18 sensor

Here unit tests are performed on the ds18_sensor module.
To perform a successful test you must connect the ds18 temperature sensor to your board.

you must also add the gpio where your board will be connected in the test init function in the main.c file

```c
void test_init_ds18(void) {
int err = init_temperature_sensor(your_gpio);

TEST_ASSERT_EQUAL_INT(0, error);
}
```

To test the code in automatic mode:

```c
make flash test
```

@}

*/
31 changes: 0 additions & 31 deletions tests/storage/doc.txt

This file was deleted.

0 comments on commit c606daa

Please sign in to comment.