Skip to content
This repository was archived by the owner on Dec 26, 2022. It is now read-only.

Commit a85b22a

Browse files
committed
fix: Make up missing doxygen docs
Some files were not included in doxygen document.
1 parent 8eca774 commit a85b22a

File tree

8 files changed

+53
-8
lines changed

8 files changed

+53
-8
lines changed

accelerator/message.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
extern "C" {
66
#endif
77

8+
/**
9+
* @file accelerator/message.h
10+
* @brief Message and options for tangled-accelerator configures
11+
*/
12+
813
typedef enum ta_cli_arg_value_e {
914
/** TA */
1015
TA_HOST_CLI = 127,

request/ta_send_mam.c

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
#include "ta_send_mam.h"
22

33
ta_send_mam_req_t* send_mam_req_new() {
4-
ta_send_mam_req_t* req = (ta_send_mam_req_t*)malloc(sizeof(ta_send_mam_req_t));
4+
ta_send_mam_req_t* req =
5+
(ta_send_mam_req_t*)malloc(sizeof(ta_send_mam_req_t));
56
if (req) {
67
req->payload_trytes = NULL;
78
}
89

910
return req;
1011
}
1112

12-
status_t send_mam_req_set_payload(ta_send_mam_req_t* req, const tryte_t* payload) {
13+
status_t send_mam_req_set_payload(ta_send_mam_req_t* req,
14+
const tryte_t* payload) {
1315
status_t ret = SC_OK;
1416
size_t payload_size = sizeof(payload) / sizeof(tryte_t);
1517

request/ta_send_mam.h

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,43 @@
88
extern "C" {
99
#endif
1010

11+
/**
12+
* @file request/ta_send_mam.h
13+
*/
14+
15+
/** struct of ta_send_transfer_req_t */
1116
typedef struct send_mam_req_s {
1217
tryte_t* payload_trytes;
1318
size_t payload_trytes_size;
1419
} ta_send_mam_req_t;
1520

21+
/**
22+
* Allocate memory of ta_send_mam_req_t
23+
*
24+
* @return
25+
* - struct of ta_send_mam_req_t on success
26+
* - NULL on error
27+
*/
1628
ta_send_mam_req_t* send_mam_req_new();
17-
status_t send_mam_req_set_payload(ta_send_mam_req_t* req, const tryte_t* payload);
29+
30+
/**
31+
* Set payload of ta_send_mam_req_t object
32+
*
33+
* @param req Data type of ta_send_transfer_req_t
34+
* @param payload Tryte data going to send with mam
35+
*
36+
* @return NULL
37+
*/
38+
status_t send_mam_req_set_payload(ta_send_mam_req_t* req,
39+
const tryte_t* payload);
40+
41+
/**
42+
* Free memory of ta_send_mam_req_t
43+
*
44+
* @param req Data type of ta_send_mam_req_t
45+
*
46+
* @return NULL
47+
*/
1848
void send_mam_req_free(ta_send_mam_req_t** req);
1949

2050
#ifdef __cplusplus

response/ta_send_mam.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
#include "ta_send_mam.h"
22

33
ta_send_mam_res_t* send_mam_res_new() {
4-
ta_send_mam_res_t* res = (ta_send_mam_res_t*)malloc(sizeof(ta_send_mam_res_t));
4+
ta_send_mam_res_t* res =
5+
(ta_send_mam_res_t*)malloc(sizeof(ta_send_mam_res_t));
56

67
return res;
78
}

response/ta_send_mam.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ extern "C" {
99
#endif
1010

1111
/**
12-
* @file response/ta_send_mam_res.h
12+
* @file response/ta_send_mam.h
1313
*/
1414

1515
/** struct of ta_send_mam_res_t */

serializer/serializer.c

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -556,7 +556,8 @@ status_t receive_mam_message_serialize(char** obj, char** const res) {
556556
return ret;
557557
}
558558

559-
status_t send_mam_res_serialize(char** obj, const ta_send_mam_res_t* const res) {
559+
status_t send_mam_res_serialize(char** obj,
560+
const ta_send_mam_res_t* const res) {
560561
status_t ret = SC_OK;
561562
cJSON* json_root = cJSON_CreateObject();
562563
if (json_root == NULL) {
@@ -610,7 +611,8 @@ status_t send_mam_res_deserialize(const char* const obj,
610611
return ret;
611612
}
612613

613-
status_t send_mam_req_deserialize(const char* const obj, ta_send_mam_req_t* req) {
614+
status_t send_mam_req_deserialize(const char* const obj,
615+
ta_send_mam_req_t* req) {
614616
if (obj == NULL) {
615617
return SC_SERIALIZER_NULL;
616618
}

serializer/serializer.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,8 @@ status_t send_mam_res_deserialize(const char* const obj,
187187
* - SC_OK on success
188188
* - non-zero on error
189189
*/
190-
status_t send_mam_req_deserialize(const char* const obj, ta_send_mam_req_t* req);
190+
status_t send_mam_req_deserialize(const char* const obj,
191+
ta_send_mam_req_t* req);
191192
#ifdef __cplusplus
192193
}
193194
#endif

utils/fill_nines.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88
extern "C" {
99
#endif
1010

11+
/**
12+
* @file utils/fill_nines.h
13+
*/
14+
1115
/**
1216
* @brief Patch input string with nines into assigned length.
1317
*

0 commit comments

Comments
 (0)