From 35df297b71bbde4e4bf75917fe23b86a0359be1f Mon Sep 17 00:00:00 2001 From: wesley-santos Date: Thu, 16 May 2024 14:04:54 -0300 Subject: [PATCH] doc: updated doxygen doc --- docs/ciot__lib_8h_source.html | 110 +++++++++++++++++----------------- docs/group__core.html | 6 ++ include/ciot_iface.h | 2 +- 3 files changed, 62 insertions(+), 56 deletions(-) diff --git a/docs/ciot__lib_8h_source.html b/docs/ciot__lib_8h_source.html index 41276b2..2c1afbf 100644 --- a/docs/ciot__lib_8h_source.html +++ b/docs/ciot__lib_8h_source.html @@ -104,61 +104,61 @@
12#ifndef __CIOT_LIB__H__
13#define __CIOT_LIB__H__
14
-
19#include "ciot.h"
-
20#include "ciot_iface.h"
-
21#include "ciot_err.h"
-
22#include "ciot_log.h"
-
23
-
28#include "types/ciot_ble_types.h"
-
29#include "types/ciot_ble_scn_types.h"
-
30#include "types/ciot_tcp_types.h"
-
31#include "types/ciot_gpio_types.h"
-
32#include "types/ciot_tcp_types.h"
-
33#include "types/ciot_wifi_types.h"
-
34#include "types/ciot_storage_types.h"
-
35#include "types/ciot_uart_types.h"
-
36#include "types/ciot_usb_types.h"
-
37
-
42#include "ciot_ble.h"
-
43#include "ciot_ble_scn.h"
-
44#include "ciot_eth.h"
-
45#include "ciot_gpio.h"
-
46#include "ciot_tcp.h"
-
47#include "ciot_wifi.h"
-
48#include "ciot_storage.h"
-
49#include "ciot_uart.h"
-
50#include "ciot_usb.h"
-
51
-
56#include "types/ciot_bridge_types.h"
-
57#include "types/ciot_dfu_types.h"
-
58#include "types/ciot_httpc_types.h"
-
59#include "types/ciot_https_types.h"
-
60#include "types/ciot_mqttc_types.h"
-
61#include "types/ciot_ntp_types.h"
-
62#include "types/ciot_opcuas_types.h"
-
63#include "types/ciot_ota_types.h"
-
64#include "types/ciot_sys_types.h"
-
65
-
70#include "ciot_bridge.h"
-
71#include "ciot_dfu.h"
-
72#include "ciot_httpc.h"
-
73#include "ciot_https.h"
-
74#include "ciot_mqttc.h"
-
75#include "ciot_nrf_dfu.h"
-
76#include "ciot_ntp.h"
-
77#include "ciot_opcuas.h"
-
78#include "ciot_opcuas.h"
-
79#include "ciot_ota.h"
-
80#include "ciot_sys.h"
-
81
-
86#include "ciot_s.h"
-
87#include "ciot_serializer.h"
-
88#include "ciot_timer.h"
-
89#include "ciot_utils.h"
-
90
-
95#include "ciot_serializer_pb.h
-
96
-
97#endif
+
24#include "ciot.h"
+
25#include "ciot_iface.h"
+
26#include "ciot_err.h"
+
27#include "ciot_log.h"
+
28
+
33#include "types/ciot_ble_types.h"
+
34#include "types/ciot_ble_scn_types.h"
+
35#include "types/ciot_tcp_types.h"
+
36#include "types/ciot_gpio_types.h"
+
37#include "types/ciot_tcp_types.h"
+
38#include "types/ciot_wifi_types.h"
+
39#include "types/ciot_storage_types.h"
+
40#include "types/ciot_uart_types.h"
+
41#include "types/ciot_usb_types.h"
+
42
+
47#include "ciot_ble.h"
+
48#include "ciot_ble_scn.h"
+
49#include "ciot_eth.h"
+
50#include "ciot_gpio.h"
+
51#include "ciot_tcp.h"
+
52#include "ciot_wifi.h"
+
53#include "ciot_storage.h"
+
54#include "ciot_uart.h"
+
55#include "ciot_usb.h"
+
56
+
61#include "types/ciot_bridge_types.h"
+
62#include "types/ciot_dfu_types.h"
+
63#include "types/ciot_httpc_types.h"
+
64#include "types/ciot_https_types.h"
+
65#include "types/ciot_mqttc_types.h"
+
66#include "types/ciot_ntp_types.h"
+
67#include "types/ciot_opcuas_types.h"
+
68#include "types/ciot_ota_types.h"
+
69#include "types/ciot_sys_types.h"
+
70
+
75#include "ciot_bridge.h"
+
76#include "ciot_dfu.h"
+
77#include "ciot_httpc.h"
+
78#include "ciot_https.h"
+
79#include "ciot_mqttc.h"
+
80#include "ciot_nrf_dfu.h"
+
81#include "ciot_ntp.h"
+
82#include "ciot_opcuas.h"
+
83#include "ciot_opcuas.h"
+
84#include "ciot_ota.h"
+
85#include "ciot_sys.h"
+
86
+
91#include "ciot_s.h"
+
92#include "ciot_serializer.h"
+
93#include "ciot_timer.h"
+
94#include "ciot_utils.h"
+
95
+
100#include "ciot_serializer_pb.h
+
101
+
102#endif
ciot.h
Header file for the CIOT core instance.
ciot_ble.h
Defines functions and types for CIOT Bluetooth Low Energy (BLE) module.
ciot_ble_scn.h
Defines functions and types for CIOT Bluetooth Low Energy (BLE) scanner.
diff --git a/docs/group__core.html b/docs/group__core.html index 5fad57e..4c03550 100644 --- a/docs/group__core.html +++ b/docs/group__core.html @@ -118,6 +118,12 @@

Detailed Description

The core of CIoT library.

+

The CIoT core consists of three modules:

diff --git a/include/ciot_iface.h b/include/ciot_iface.h index 5111b26..b8f61be 100644 --- a/include/ciot_iface.h +++ b/include/ciot_iface.h @@ -1,7 +1,7 @@ /** * @file ciot_iface.h * @ingroup core - * @brief Header file for the CIOT interface. + * @brief Header file for the common CIoT interface abstraction. * @details An CIoT interface is an common abstraction that must be implemented by any resource which is desired to be managed by CIoT core. * To create an new CIoT interface implementation, an ciot_iface_t instance type must be initialized. So the CIoT core can use the instance * to automate the interface behavior like start/stop or process an external request. When an new interface is implemented, some rules must