From e2a1211ea895176898ade08b419bae20bb2ff892 Mon Sep 17 00:00:00 2001 From: asterix Date: Fri, 7 May 2010 13:37:30 +0000 Subject: [PATCH] Add comments. git-svn-id: https://src.develer.com/svnoss/bertos/trunk@3626 38d2e660-2303-0410-9eaa-f027e97ec537 --- bertos/net/keytag.c | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/bertos/net/keytag.c b/bertos/net/keytag.c index 2376305a..32473ceb 100644 --- a/bertos/net/keytag.c +++ b/bertos/net/keytag.c @@ -31,8 +31,12 @@ * --> * * \author Andrea Grandi + * \author Daniele Basile * - * \brief Tag protocol (protocol). + * \brief KeyTAG parser. + * + * This module parse TAG message that come from comunication channel, + * and convert the tag value into string. * * TAG protocol is decribed in this way: *
@@ -85,6 +89,11 @@ void keytag_poll(struct TagPacket *pkt)
 		kfile_write(pkt->host, buf, len);
 }
 
+/**
+ * Receive the tag message from channel, and if
+ * the tag is good put the converted string into given buffer.
+ * The fuction return the len of found tag string, otherwise EOF.
+ */
 int keytag_recv(struct TagPacket *pkt, uint8_t *tag, size_t len)
 {
 	int c;
-- 
2.25.1