Skip to content

Commit 908fcb2

Browse files
marekmaskarinechubmartin
marekmaskarinec
authored and
hubmartin
committed
docs: Improve Doxygen documentation
1 parent 3f8cde1 commit 908fcb2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+467
-9
lines changed

‎doc/custom.css

+19-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
11
@media (prefers-color-scheme: dark) {
2-
html:not(.light-mode) {
3-
--primary-color: rgba(227, 4, 39, 1);
4-
--primary-dark-color: rgb(33, 175, 144);
5-
--primary-light-color: rgb(70, 203, 174);
6-
--page-background-color: #1b1b1b;
7-
--fragment-background: rgb(37, 37, 50);
8-
}
2+
html:not(.light-mode) {
3+
--primary-color: #e30427;
4+
--primary-dark-color: rgb(33, 175, 144);
5+
--primary-light-color: rgb(70, 203, 174);
6+
--page-background-color: #252532;
7+
--page-foreground-color: #f2faff;
8+
--side-nav-background: #202026;
9+
--fragment-background: #303040;
10+
--side-nav-arrow-opacity: 1;
11+
--side-nav-arrow-hover-opacity: 0.2;
12+
}
13+
14+
#projectbrief {
15+
display: none;
16+
}
17+
18+
#projectname {
19+
display: none;
20+
}
921
}
1022

‎doc/logo.png

3.71 KB
Loading

‎include/chester/ctr_accel.h

+7
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,15 @@
1111
extern "C" {
1212
#endif
1313

14+
/**
15+
* @addtogroup ctr_accel ctr_accel
16+
* @{
17+
*/
18+
1419
int ctr_accel_read(float *accel_x, float *accel_y, float *accel_z, int *orientation);
1520

21+
/** @} */
22+
1623
#ifdef __cplusplus
1724
}
1825
#endif

‎include/chester/ctr_adc.h

+8-1
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,13 @@
1414
extern "C" {
1515
#endif
1616

17+
/**
18+
* @addtogroup ctr_adc ctr_adc
19+
* @{
20+
*/
21+
1722
/* Default ADC gain is 1/6 */
18-
#define CTR_ADC_MILLIVOLTS(_sample) (((uint32_t)(_sample)) * 600 * 6 / 4095)
23+
#define CTR_ADC_MILLIVOLTS(_sample) (((uint32_t)(_sample)) * 600 * 6 / 4095)
1924
#define CTR_ADC_MILLIVOLTS_GAIN_1(_sample) (((uint32_t)(_sample)) * 600 * 1 / 4095)
2025

2126
/* X0 contains 100kΩ and 10kΩ voltage divider when PD is enabled */
@@ -42,6 +47,8 @@ enum ctr_adc_channel {
4247
int ctr_adc_init(enum ctr_adc_channel channel);
4348
int ctr_adc_read(enum ctr_adc_channel channel, uint16_t *sample);
4449

50+
/** @} */
51+
4552
#ifdef __cplusplus
4653
}
4754
#endif

‎include/chester/ctr_buf.h

+7
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@
1515
extern "C" {
1616
#endif
1717

18+
/**
19+
* @addtogroup ctr_buf ctr_buf
20+
* @{
21+
*/
22+
1823
#define CTR_BUF_DEFINE(_name, _size) \
1924
uint8_t _name##_mem[_size]; \
2025
struct ctr_buf _name = { \
@@ -72,6 +77,8 @@ int ctr_buf_append_float_be(struct ctr_buf *buf, float val);
7277
#define ctr_buf_append_u64(buf, val) ctr_buf_append_u64_le(buf, val) __DEPRECATED_MACRO
7378
#define ctr_buf_append_float(buf, val) ctr_buf_append_float_le(buf, val) __DEPRECATED_MACRO
7479

80+
/** @} */
81+
7582
#ifdef __cplusplus
7683
}
7784
#endif

‎include/chester/ctr_button.h

+8-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111
extern "C" {
1212
#endif
1313

14+
/**
15+
* @addtogroup ctr_button ctr_button
16+
* @{
17+
*/
18+
1419
enum ctr_button_channel {
1520
CTR_BUTTON_CHANNEL_INT = 0,
1621
CTR_BUTTON_CHANNEL_EXT = 1,
@@ -22,10 +27,12 @@ enum ctr_button_event {
2227
};
2328

2429
typedef void (*ctr_button_event_cb)(enum ctr_button_channel, enum ctr_button_event event, int value,
25-
void *user_data);
30+
void *user_data);
2631

2732
int ctr_button_set_event_cb(ctr_button_event_cb cb, void *user_data);
2833

34+
/** @} */
35+
2936
#ifdef __cplusplus
3037
}
3138
#endif

‎include/chester/ctr_config.h

+7
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,19 @@
1717
extern "C" {
1818
#endif
1919

20+
/**
21+
* @addtogroup ctr_config ctr_config
22+
* @{
23+
*/
24+
2025
typedef int (*ctr_config_show_cb)(const struct shell *shell, size_t argc, char **argv);
2126

2227
int ctr_config_save(void);
2328
int ctr_config_reset(void);
2429
void ctr_config_append_show(const char *name, ctr_config_show_cb cb);
2530

31+
/** @} */
32+
2633
#ifdef __cplusplus
2734
}
2835
#endif

‎include/chester/ctr_ds18b20.h

+7
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,17 @@
1414
extern "C" {
1515
#endif
1616

17+
/**
18+
* @addtogroup ctr_ds18b20 ctr_ds18b20
19+
* @{
20+
*/
21+
1722
int ctr_ds18b20_scan(void);
1823
int ctr_ds18b20_get_count(void);
1924
int ctr_ds18b20_read(int index, uint64_t *serial_number, float *temperature);
2025

26+
/** @} */
27+
2128
#ifdef __cplusplus
2229
}
2330
#endif

‎include/chester/ctr_edge.h

+7
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@
1818
extern "C" {
1919
#endif
2020

21+
/**
22+
* @addtogroup ctr_edge ctr_edge
23+
* @{
24+
*/
25+
2126
enum ctr_edge_event {
2227
CTR_EDGE_EVENT_INACTIVE = 0,
2328
CTR_EDGE_EVENT_ACTIVE = 1,
@@ -54,6 +59,8 @@ int ctr_edge_set_inactive_duration(struct ctr_edge *edge, int msec);
5459
int ctr_edge_watch(struct ctr_edge *edge);
5560
int ctr_edge_unwatch(struct ctr_edge *edge);
5661

62+
/** @} */
63+
5764
#ifdef __cplusplus
5865
}
5966
#endif

‎include/chester/ctr_flash.h

+7
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,16 @@
1111
extern "C" {
1212
#endif
1313

14+
/**
15+
* @addtogroup ctr_flash ctr_flash
16+
* @{
17+
*/
18+
1419
int ctr_flash_acquire(void);
1520
int ctr_flash_release(void);
1621

22+
/** @} */
23+
1724
#ifdef __cplusplus
1825
}
1926
#endif

‎include/chester/ctr_gnss.h

+7
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@
1414
extern "C" {
1515
#endif
1616

17+
/**
18+
* @addtogroup ctr_gnss ctr_gnss
19+
* @{
20+
*/
21+
1722
enum ctr_gnss_event {
1823
CTR_GNSS_EVENT_FAILURE = -1,
1924
CTR_GNSS_EVENT_START_OK = 0,
@@ -62,6 +67,8 @@ int ctr_gnss_set_handler(ctr_gnss_user_cb user_cb, void *user_data);
6267
int ctr_gnss_start(int *corr_id);
6368
int ctr_gnss_stop(bool keep_bckp_domain, int *corr_id);
6469

70+
/** @} */
71+
6572
#ifdef __cplusplus
6673
}
6774
#endif

‎include/chester/ctr_gpio.h

+7
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111
extern "C" {
1212
#endif
1313

14+
/**
15+
* @addtogroup ctr_gpio ctr_gpio
16+
* @{
17+
*/
18+
1419
enum ctr_gpio_channel {
1520
CTR_GPIO_CHANNEL_A0 = 0,
1621
CTR_GPIO_CHANNEL_A1 = 1,
@@ -35,6 +40,8 @@ int ctr_gpio_set_mode(enum ctr_gpio_channel channel, enum ctr_gpio_mode mode);
3540
int ctr_gpio_read(enum ctr_gpio_channel channel, int *value);
3641
int ctr_gpio_write(enum ctr_gpio_channel channel, int value);
3742

43+
/** @} */
44+
3845
#ifdef __cplusplus
3946
}
4047
#endif

‎include/chester/ctr_hygro.h

+7
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,15 @@
1111
extern "C" {
1212
#endif
1313

14+
/**
15+
* @addtogroup ctr_hygro ctr_hygro
16+
* @{
17+
*/
18+
1419
int ctr_hygro_read(float *temperature, float *humidity);
1520

21+
/** @} */
22+
1623
#ifdef __cplusplus
1724
}
1825
#endif

‎include/chester/ctr_info.h

+7
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@
1414
extern "C" {
1515
#endif
1616

17+
/**
18+
* @addtogroup ctr_info ctr_info
19+
* @{
20+
*/
21+
1722
int ctr_info_get_vendor_name(char **vendor_name);
1823
int ctr_info_get_product_name(char **product_name);
1924
int ctr_info_get_hw_variant(char **hw_variant);
@@ -27,6 +32,8 @@ int ctr_info_get_ble_devaddr(char **ble_devaddr);
2732
int ctr_info_get_ble_devaddr_uint64(uint64_t *ble_devaddr);
2833
int ctr_info_get_ble_passkey(char **ble_passkey);
2934

35+
/** @} */
36+
3037
#ifdef __cplusplus
3138
}
3239
#endif

‎include/chester/ctr_led.h

+7
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@
1616
extern "C" {
1717
#endif
1818

19+
/**
20+
* @addtogroup ctr_led
21+
* @{
22+
*/
23+
1924
enum ctr_led_channel {
2025
CTR_LED_CHANNEL_R = 0,
2126
CTR_LED_CHANNEL_G = 1,
@@ -33,6 +38,8 @@ static inline int ctr_led_set(enum ctr_led_channel channel, bool is_on)
3338
}
3439
}
3540

41+
/** @} */
42+
3643
#ifdef __cplusplus
3744
}
3845
#endif

‎include/chester/ctr_lrw.h

+7
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@
1616
extern "C" {
1717
#endif
1818

19+
/**
20+
* @addtogroup ctr_lrw ctr_lrw
21+
* @{
22+
*/
23+
1924
enum ctr_lrw_event {
2025
CTR_LRW_EVENT_FAILURE = -1,
2126
CTR_LRW_EVENT_START_OK = 0,
@@ -78,6 +83,8 @@ int ctr_lrw_start(int *corr_id);
7883
int ctr_lrw_join(int *corr_id);
7984
int ctr_lrw_send(const struct ctr_lrw_send_opts *opts, const void *buf, size_t len, int *corr_id);
8085

86+
/** @} */
87+
8188
#ifdef __cplusplus
8289
}
8390
#endif

‎include/chester/ctr_lte.h

+7
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@
1616
extern "C" {
1717
#endif
1818

19+
/**
20+
* @addtogroup ctr_lte ctr_lte
21+
* @{
22+
*/
23+
1924
enum ctr_lte_event {
2025
CTR_LTE_EVENT_FAILURE = -1,
2126
CTR_LTE_EVENT_START_OK = 0,
@@ -121,6 +126,8 @@ int ctr_lte_detach(int *corr_id);
121126
int ctr_lte_eval(int *corr_id);
122127
int ctr_lte_send(const struct ctr_lte_send_opts *opts, const void *buf, size_t len, int *corr_id);
123128

129+
/** @} */
130+
124131
#ifdef __cplusplus
125132
}
126133
#endif

‎include/chester/ctr_machine_probe.h

+7
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@
1515
extern "C" {
1616
#endif
1717

18+
/**
19+
* @addtogroup ctr_machine_probe ctr_machine_probe
20+
* @{
21+
*/
22+
1823
int ctr_machine_probe_scan(void);
1924
int ctr_machine_probe_get_count(void);
2025
int ctr_machine_probe_read_thermometer(int index, uint64_t *serial_number, float *temperature);
@@ -29,6 +34,8 @@ int ctr_machine_probe_enable_tilt_alert(int index, uint64_t *serial_number, int
2934
int ctr_machine_probe_disable_tilt_alert(int index, uint64_t *serial_number);
3035
int ctr_machine_probe_get_tilt_alert(int index, uint64_t *serial_number, bool *is_active);
3136

37+
/** @} */
38+
3239
#ifdef __cplusplus
3340
}
3441
#endif

‎include/chester/ctr_rtc.h

+7
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@
1818
extern "C" {
1919
#endif
2020

21+
/**
22+
* @addtogroup ctr_rtc ctr_rtc
23+
* @{
24+
*/
25+
2126
struct ctr_rtc_tm {
2227
/* Year in the Anno Domini calendar (e.g. 2022) */
2328
int year;
@@ -47,6 +52,8 @@ int ctr_rtc_get_ts(int64_t *ts);
4752
int ctr_rtc_set_ts(int64_t ts);
4853
int ctr_rtc_wait_set(k_timeout_t timeout);
4954

55+
/** @} */
56+
5057
#ifdef __cplusplus
5158
}
5259
#endif

‎include/chester/ctr_rtd.h

+7
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111
extern "C" {
1212
#endif
1313

14+
/**
15+
* @addtogroup ctr_rtd ctr_rtd
16+
* @{
17+
*/
18+
1419
enum ctr_rtd_channel {
1520
CTR_RTD_CHANNEL_A1 = 0,
1621
CTR_RTD_CHANNEL_A2 = 1,
@@ -25,6 +30,8 @@ enum ctr_rtd_type {
2530

2631
int ctr_rtd_read(enum ctr_rtd_channel channel, enum ctr_rtd_type type, float *temperature);
2732

33+
/** @} */
34+
2835
#ifdef __cplusplus
2936
}
3037
#endif

0 commit comments

Comments
 (0)