Protocol: updated docs for functions that survived redesign.

Signed-off-by: Ramūnas Mažeikis <ramunasnezinomas@gmail.com>

1 files changed, 13 insertions, 0 deletions

diff --git a/src/common/protocol_private.h b/src/common/protocol_private.h
index de086cd..fe28aa0 100644
--- a/src/common/protocol_private.h
+++ b/src/common/protocol_private.h
@@ -3,7 +3,20 @@
 
 #include "protocol_private.h"
 
+/**
+ * Convenience function that pushes bytes to the end of a packet and reports
+ * potential overflow.
+ *
+ * In case of detected overflow nothing is done to the packet.
+ */
 int push_bytes(struct tlv_packet *packet, char *data, size_t size);
+
+/**
+ * Convenience function that forms a tlv header at the end of a packet. Reports
+ * potential overflow.
+ *
+ * In case of detected overflow nothing is done to the packet.
+ */
 int push_tlv_header(struct tlv_packet *packet, enum tlv_type type, size_t size);
 
 #endif /* PROTOCOL_PRIVATE_H */
\ No newline at end of file