[HTTP_DECODER]add some comments

1 files changed, 14 insertions, 3 deletions

diff --git a/src/http_decoder/http_decoder.h b/src/http_decoder/http_decoder.h
index d99830b..24b96c6 100644
--- a/src/http_decoder/http_decoder.h
+++ b/src/http_decoder/http_decoder.h
@@ -3,12 +3,11 @@
 *	File: http_decoder.h
 *   Description: 
 *	Authors: Liu WenTan <[email protected]>
-*	Date:    2022-10-31
+*	Date:    2024-01-10
 *   Copyright: (c) Since 2022 Geedge Networks, Ltd. All rights reserved.
 ***********************************************************************************************
 */
 
-
 #ifndef _HTTP_DECODER_H_
 #define _HTTP_DECODER_H_
 
@@ -19,7 +18,6 @@ extern "C"
 
 #include <stddef.h>
 
-
 enum http_message_type {
     HTTP_MESSAGE_REQ_LINE,
     HTTP_MESSAGE_REQ_HEADER,
@@ -63,6 +61,9 @@ struct http_message;
 
 enum http_message_type http_message_type(struct http_message *msg);
 
+/**
+ * @retval succeed(0) failed(-1)
+*/
 int http_message_get_request_line(struct http_message *msg,
                                   struct http_request_line *line);
 
@@ -76,12 +77,20 @@ int http_message_get_request_header(struct http_message *msg, struct hstring *ke
 int http_message_get_response_header(struct http_message *msg, struct hstring *key,
                                      struct http_header *hdr_array, size_t array_size);
 
+/**
+ * @brief loop reading all headers
+ * 
+ * @retval succeed(1) failed(<= 0)
+*/
 int http_message_request_header_next(struct http_message *msg,
                                      struct http_header *header);
 
 int http_message_response_header_next(struct http_message *msg,
                                       struct http_header *header);
 
+/**
+ * @retval succeed(0) failed(-1)
+*/
 int http_message_get_request_raw_body(struct http_message *msg,
                                       struct hstring *body);
 
@@ -90,6 +99,8 @@ int http_message_get_response_raw_body(struct http_message *msg,
 
 /**
  * @brief If the body hasn't been compressed, return raw body
+ * 
+ * @retval succeed(0) failed(-1)
 */
 int http_message_get_request_decompress_body(struct http_message *msg,
                                              struct hstring *body);