From 59e02d028bf407e4e2ccda823f5360d2e59f7ee4 Mon Sep 17 00:00:00 2001
From: batt <batt@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Sat, 10 Oct 2009 12:41:06 +0000
Subject: [PATCH] Add some doc.

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@3068 38d2e660-2303-0410-9eaa-f027e97ec537
---
 bertos/net/afsk.c | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/bertos/net/afsk.c b/bertos/net/afsk.c
index 01b43474..4a195891 100644
--- a/bertos/net/afsk.c
+++ b/bertos/net/afsk.c
@@ -119,7 +119,16 @@ INLINE uint8_t sin_sample(uint16_t idx)
 #define BIT_DIFFER(bitline1, bitline2) (((bitline1) ^ (bitline2)) & 0x01)
 #define EDGE_FOUND(bitline)            BIT_DIFFER((bitline), (bitline) >> 1)
 
-
+/**
+ * High-Level Data Link Control parsing function.
+ * Parse bitstream in order to find characters.
+ *
+ * \param hdlc HDLC context.
+ * \param bit  current bit to be parsed.
+ * \param fifo FIFO buffer used to push characters.
+ *
+ * \return True if all is ok, False if the fifo is full.
+ */
 static bool hdlc_parse(Hdlc *hdlc, bool bit, FIFOBuffer *fifo)
 {
 	bool ret = true;
-- 
2.25.1