summaryrefslogtreecommitdiff
path: root/shared
diff options
context:
space:
mode:
authorlonkaars <loek@pipeframe.xyz>2022-05-26 22:46:17 +0200
committerlonkaars <loek@pipeframe.xyz>2022-05-26 22:46:17 +0200
commitbfa494588da0def96c42577e284c6d8990eb31f2 (patch)
tree29b98f8a2cbfea31a0f6641d8cd77b211ac5defe /shared
parentb6460d729aa683643e7ad83a9921f335f0fdba93 (diff)
add doxygen
Diffstat (limited to 'shared')
-rw-r--r--shared/bin.h3
-rw-r--r--shared/consts.h4
-rw-r--r--shared/errors.h2
-rw-r--r--shared/protocol.h2
-rw-r--r--shared/semver.h2
-rw-r--r--shared/serial_parse.h2
-rw-r--r--shared/util.h2
7 files changed, 16 insertions, 1 deletions
diff --git a/shared/bin.h b/shared/bin.h
index af3a249..48485c8 100644
--- a/shared/bin.h
+++ b/shared/bin.h
@@ -1,4 +1,7 @@
#pragma once
+
+/** @file bin.h */
+
/**
* helper file for binary data
*
diff --git a/shared/consts.h b/shared/consts.h
index 70ab5b2..50b16b9 100644
--- a/shared/consts.h
+++ b/shared/consts.h
@@ -1,5 +1,7 @@
#pragma once
+/** @file consts.h */
+
#ifndef W2_BUILD_STR
// is defined by CFLAGS += -DW2_BUILD_STR in makefile
#define W2_BUILD_STR ("????????")
@@ -30,4 +32,4 @@
/** battery voltage sensor pinout */
#define W2_BATTERY_PIN 6
/** side-facing distance sensor pinout */
-#define W2_SIDE_SENSOR_PIN 7 \ No newline at end of file
+#define W2_SIDE_SENSOR_PIN 7
diff --git a/shared/errors.h b/shared/errors.h
index ac8e95f..4c9f7c8 100644
--- a/shared/errors.h
+++ b/shared/errors.h
@@ -1,5 +1,7 @@
#pragma once
+/** @file errors.h */
+
#include <stdint.h>
#define W2_E_TYPE_MASK (0b11 << 6)
diff --git a/shared/protocol.h b/shared/protocol.h
index 7aa5e9f..05cde03 100644
--- a/shared/protocol.h
+++ b/shared/protocol.h
@@ -1,5 +1,7 @@
#pragma once
+/** @file protocol.h */
+
#include <stdint.h>
#include <stdlib.h>
diff --git a/shared/semver.h b/shared/semver.h
index a99ae61..6a1da79 100644
--- a/shared/semver.h
+++ b/shared/semver.h
@@ -1,5 +1,7 @@
#pragma once
+/** @file semver.h */
+
#include <stdint.h>
typedef struct {
diff --git a/shared/serial_parse.h b/shared/serial_parse.h
index a1c8fb9..03c420f 100644
--- a/shared/serial_parse.h
+++ b/shared/serial_parse.h
@@ -1,5 +1,7 @@
#pragma once
+/** @file serial_parse.h */
+
#include <stdint.h>
#include "protocol.h"
diff --git a/shared/util.h b/shared/util.h
index 9e4d8ac..465e043 100644
--- a/shared/util.h
+++ b/shared/util.h
@@ -1,5 +1,7 @@
#pragma once
+/** @file util.h */
+
#define W2_MIN(a, b) (((a) < (b)) ? (a) : (b))
#define W2_MAX(a, b) (((a) > (b)) ? (a) : (b))
#define W2_RANGE(min, val, max) W2_MIN(max, W2_MAX(val, min))