Add some doc.

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

diff --git a/bertos/net/afsk.c b/bertos/net/afsk.c
index 01b4347423030e146af30799870886d7eed1fda3..4a195891d9befe3e1a96c7d5b5dafc86fa854678 100644 (file)
--- 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;