Move function doc in the implementation file.

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

diff --git a/bertos/net/ax25.c b/bertos/net/ax25.c
index 889136595f52997830d310eb5cf342bce1d6f12e..32adf4ebbfe435c1f6635bf1001a97ab1e2ee342 100644 (file)
--- a/bertos/net/ax25.c
+++ b/bertos/net/ax25.c
@@ -112,6 +112,17 @@ static void ax25_decode(AX25Ctx *ctx)
                ctx->hook(&msg);
 }
 
+
+/**
+ * Check if there are any AX25 messages to be processed.
+ * This function read available characters from the medium and search for
+ * any AX25 messages.
+ * If a message is found it is decoded and the linked callback executed.
+ * This function may be blocking if there are no available chars and the KFile
+ * used in \a ctx to access the medium is configured in blocking mode.
+ *
+ * \param ctx AX25 context to operate on.
+ */
 void ax25_poll(AX25Ctx *ctx)
 {
        int c;
@@ -201,6 +212,16 @@ static void ax25_sendCall(AX25Ctx *ctx, const AX25Call *addr)
                        ax25_putchar(ctx, ' ' << 1);
 }
 
+/**
+ * Send an AX25 frame on the channel.
+ * \param ctx AX25 context to operate on.
+ * \param dst the destination callsign for the frame, \see AX25_CALL
+ *        for a handy way to create a callsign on the fly.
+ * \param src the source callsign for the frame, \see AX25_CALL
+ *        for a handy way to create a callsign on the fly.
+ * \param _buf payload buffer.
+ * \param len length of the payload.
+ */
 void ax25_send(AX25Ctx *ctx, const AX25Call *dst, const AX25Call *src, const void *_buf, size_t len)
 {
        const uint8_t *buf = (const uint8_t *)_buf;
@@ -233,6 +254,14 @@ void ax25_send(AX25Ctx *ctx, const AX25Call *dst, const AX25Call *src, const voi
        kfile_putc(HDLC_FLAG, ctx->ch);
 }
 
+
+/**
+ * Init the AX25 protocol decoder.
+ *
+ * \param ctx AX25 context to init.
+ * \param channel Used to gain access to the physical medium
+ * \param hook Callback function called when a message is received
+ */
 void ax25_init(AX25Ctx *ctx, KFile *channel, ax25_callback_t hook)
 {
        ASSERT(ctx);

diff --git a/bertos/net/ax25.h b/bertos/net/ax25.h
index 5daabd5b4b9481cfe2ad382f8e6302dfe16c3593..da56b28b5c1b9e30aecd1109c3fb0d41e554483c 100644 (file)
--- a/bertos/net/ax25.h
+++ b/bertos/net/ax25.h
@@ -141,38 +141,9 @@ typedef struct AX25Msg
 /* \} */
 
 
-/**
- * Check if there are any AX25 messages to be processed.
- * This function read available characters from the medium and search for
- * any AX25 messages.
- * If a message is found it is decoded and the linked callback executed.
- * This function may be blocking if there are no available chars and the KFile
- * used in \a ctx to access the medium is configured in blocking mode.
- *
- * \param ctx AX25 context to operate on.
- */
-void ax25_poll(AX25Ctx *ctx);
 
-/**
- * Send an AX25 frame on the channel.
- * \param ctx AX25 context to operate on.
- * \param dst the destination callsign for the frame, \see AX25_CALL
- *        for a handy way to create a callsign on the fly.
- * \param src the source callsign for the frame, \see AX25_CALL
- *        for a handy way to create a callsign on the fly.
- * \param _buf payload buffer.
- * \param len length of the payload.
- */
+void ax25_poll(AX25Ctx *ctx);
 void ax25_send(AX25Ctx *ctx, const AX25Call *dst, const AX25Call *src, const void *_buf, size_t len);
-
-
-/**
- * Init the AX25 protocol decoder.
- *
- * \param ctx AX25 context to init.
- * \param channel Used to gain access to the physical medium
- * \param hook Callback function called when a message is received
- */
 void ax25_init(AX25Ctx *ctx, KFile *channel, ax25_callback_t hook);
 
 int ax25_testSetup(void);