From: asterix <asterix@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Fri, 7 May 2010 13:37:30 +0000 (+0000)
Subject: Add comments.
X-Git-Tag: 2.5.0~282
X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=e2a1211ea895176898ade08b419bae20bb2ff892;p=bertos.git

Add comments.

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@3626 38d2e660-2303-0410-9eaa-f027e97ec537
---

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 <andrea@develer.com>
+ * \author Daniele Basile <asterix@develer.com>
  *
- * \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:
  * <pre>
@@ -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;