fixed some documentation issues

api/shellmatta.h

@@ -26,7 +26,7 @@
 /* global defines */
 
 
-/*
+/**
  * Define the printf format specifier for all GCC versions > 3.3
  * This will let the compiler know that shellmatta_printf() is a function taking printf-like format specifiers.
  */
@@ -303,14 +303,14 @@ typedef uint32_t (*shellmatta_transport_crc_t)(const char* data, const uint32_t
  */
 typedef struct __attribute__((__packed__))
 {
-    uint8_t startOfHeader;      /** start of header field               */
-    uint8_t protocolVersion;    /** protocol version of the packet      */
-    uint8_t packetType;         /** type of the packet                  */
-    uint8_t payloadLength;      /** length of the payload               */
-    uint8_t source;             /** source of the packet                */
-    uint8_t destination;        /** destination of the packet           */
-    uint8_t sequenceH2S;        /** sequence counter host to shellmatta */
-    uint8_t sequenceS2H;        /** sequence counter shellmatta to host */
+    uint8_t startOfHeader;      /**< start of header field                  */
+    uint8_t protocolVersion;    /**< protocol version of the packet         */
+    uint8_t packetType;         /**< type of the packet                     */
+    uint8_t payloadLength;      /**< length of the payload                  */
+    uint8_t source;             /**< source of the packet                   */
+    uint8_t destination;        /**< destination of the packet              */
+    uint8_t sequenceH2S;        /**< sequence counter host to shellmatta    */
+    uint8_t sequenceS2H;        /**< sequence counter shellmatta to host    */
 } shellmatta_transport_header_t;
 
 /**

makefile

@@ -37,8 +37,7 @@ SOURCES :=  src/shellmatta.c                \
 
 
 SOURCES_TRANPORT_LAYER  :=  $(SOURCES)                      \
-                            src/shellmatta_transport.c      \
-                            src/shellmatta_crc.c
+                            src/shellmatta_transport.c
 AUTH_SOURCES     := $(SOURCES) src/shellmatta_auth.c
 EXAMPLE_SOURCES  := example/main.c
 EXAMPLE_SOURCES  += $(filter-out $(EXAMPLE_SOURCES),$(AUTH_SOURCES))

src/shellmatta_auth.c

@@ -410,7 +410,7 @@ shellmatta_retCode_t shellmatta_auth_init(shellmatta_handle_t       handle,
  * @param[in]   handle      shellmatta instance handle
  * @param[in]   userId      userId to login
  * @return      errorcode   #SHELLMATTA_OK
- *                          #SHELLMATTA_ERR (user does not exist)
+ *                          #SHELLMATTA_ERROR (user does not exist)
  *                          #SHELLMATTA_USE_FAULT (param err)
  */
 shellmatta_retCode_t shellmatta_auth_login(shellmatta_handle_t handle, uint32_t userId)

src/shellmatta_transport.c

@@ -430,7 +430,7 @@ shellmatta_retCode_t shellmatta_transport_process(shellmatta_transport_layer_t
  * The input data is copied into a new array along with the header and crc32.\n
  * The resulting buffer is the forwarded to the original write function.\n
  *
- * @note        If length of data exceeds #UINT8_MAX, data is sent in multiple packets.\n
+ * @note        If length of data exceeds UINT8_MAX, data is sent in multiple packets.\n
  *
  * @param[in, out]  transportLayer  transport layer instance to work on
  * @param[in]       data            pointer to input data to process

src/shellmatta_utils.h

@@ -50,7 +50,6 @@
  * @brief       calls fct with cnt bytes from buffer (to print cnt same bytes)
  * @param[in]   buffer  buffer to send (shall contain the same char)
  * @param[in]   cnt     count of bytes to send
- * @param[in]   fct     write function
  */
 #define SHELLMATTA_PRINT_BUFFER(buffer,cnt)             \
     while((cnt) > sizeof((buffer)))                     \