doc: fixed remaining doxygen warnings in core

Only one warning remains and will be fixed in a separate commit.

core/include/arch/hwtimer_arch.h

@@ -31,7 +31,7 @@
 /**
  * @brief Initialize architecture dependent kernel timer support
  *
- * @param[in] handler   callback that is called when timer offset is reached
+ * @param[in] handler   callback that is called when timer @p offset is reached
  * @param[in] fcpu      the core CPU-frequency for tick interval calculation
  */
 void hwtimer_arch_init(void (*handler)(int), uint32_t fcpu);
@@ -47,7 +47,7 @@ void hwtimer_arch_enable_interrupt(void);
 void hwtimer_arch_disable_interrupt(void);
 
 /**
- * @brief Set a kernel timer to raise an interrupt after ::offset kernel timer
+ * @brief Set a kernel timer to raise an interrupt after @p offset kernel timer
  *              ticks from now
  *
  * @param[in] offset    number of ticks until the timer fires

core/include/byteorder.h

@@ -34,8 +34,8 @@ extern "C" {
  *                 between different byte orders at compile time.
  */
 typedef union __attribute__((packed)) {
-    uint8_t      u8[2];
-    uint16_t    u16;
+    uint8_t      u8[2]; /**< 8 bit representation */
+    uint16_t    u16;    /**< 16 bit representation */
 } le_uint16_t;
 
 /**
@@ -44,10 +44,10 @@ typedef union __attribute__((packed)) {
  *                 between different byte orders at compile time.
  */
 typedef union __attribute__((packed)) {
-    uint8_t      u8[4];
-    uint16_t    u16[2];
-    uint32_t    u32;
-    le_uint16_t l16[2];
+    uint8_t      u8[4]; /**< 8 bit representation */
+    uint16_t    u16[2]; /**< 16 bit representation */
+    uint32_t    u32;    /**< 32 bit representation */
+    le_uint16_t l16[2]; /**< little endian 16 bit representation */
 } le_uint32_t;
 
 /**
@@ -56,12 +56,12 @@ typedef union __attribute__((packed)) {
  *                 between different byte orders at compile time.
  */
 typedef union __attribute__((packed)) {
-    uint8_t      u8[8];
-    uint16_t    u16[4];
-    uint32_t    u32[2];
-    uint64_t    u64;
-    le_uint16_t l16[4];
-    le_uint32_t l32[2];
+    uint8_t      u8[8]; /**< 8 bit representation */
+    uint16_t    u16[4]; /**< 16 bit representation */
+    uint32_t    u32[2]; /**< 32 bit representation */
+    uint64_t    u64;    /**< 64 bit representation */
+    le_uint16_t l16[4]; /**< little endian 16 bit representation */
+    le_uint32_t l32[2]; /**< little endian 32 bit representation */
 } le_uint64_t;
 
 /**
@@ -70,8 +70,8 @@ typedef union __attribute__((packed)) {
  *                 between different byte orders at compile time.
  */
 typedef union __attribute__((packed)) {
-    uint8_t      u8[2];
-    uint16_t    u16;
+    uint8_t      u8[2]; /**< 8 bit representation */
+    uint16_t    u16;    /**< 16 bit representation */
 } be_uint16_t;
 
 /**
@@ -80,10 +80,10 @@ typedef union __attribute__((packed)) {
  *                 between different byte orders at compile time.
  */
 typedef union __attribute__((packed)) {
-    uint8_t      u8[4];
-    uint16_t    u16[2];
-    uint32_t    u32;
-    be_uint16_t b16[2];
+    uint8_t      u8[4]; /**< 8 bit representation */
+    uint16_t    u16[2]; /**< 16 bit representation */
+    uint32_t    u32;    /**< 32 bit representation */
+    be_uint16_t b16[2]; /**< big endian 16 bit representation */
 } be_uint32_t;
 
 /**
@@ -92,16 +92,27 @@ typedef union __attribute__((packed)) {
  *                 between different byte orders at compile time.
  */
 typedef union __attribute__((packed)) {
-    uint8_t      u8[8];
-    uint16_t    u16[4];
-    uint32_t    u32[2];
-    uint64_t    u64;
-    be_uint16_t b16[4];
-    be_uint32_t b32[2];
+    uint8_t      u8[8]; /**< 8 bit representation */
+    uint16_t    u16[4]; /**< 16 bit representation */
+    uint32_t    u32[2]; /**< 32 bit representation */
+    uint64_t    u64;    /**< 64 bit representation */
+    be_uint16_t b16[4]; /**< big endian 16 bit representation */
+    be_uint32_t b32[2]; /**< big endian 32 bit representation */
 } be_uint64_t;
 
+/**
+ * @brief A 16 bit integer in network byte order.
+ */
 typedef be_uint16_t network_uint16_t;
+
+/**
+ * @brief A 32 bit integer in network byte order.
+ */
 typedef be_uint32_t network_uint32_t;
+
+/**
+ * @brief A 64 bit integer in network byte order.
+ */
 typedef be_uint64_t network_uint64_t;
 
 /**
@@ -272,6 +283,9 @@ static inline le_uint64_t byteorder_btolll(be_uint64_t v)
     return result;
 }
 
+/**
+ * @brief Swaps the byteorder according to the endianess
+ */
 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
 #   define _byteorder_swap(V, T) (byteorder_swap##T((V)))
 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__

core/include/debug.h

@@ -13,7 +13,8 @@
  * @file        debug.h
  * @brief       Debug-header
  *
- * #define ENABLE_DEBUG, include this and then use DEBUG as printf you can toggle.
+ * @details     If ENABLE_DEBUG is set, before this header is included, 
+ *              ::DEBUG will print out to stdout, otherwise do nothing
  *
  * @author      Kaspar Schleiser <kaspar@schleiser.de>
  */

core/include/kernel.h

@@ -117,7 +117,7 @@ extern volatile int lpm_prevent_sleep;
 /**
  * @brief Variable used to store system configuration
  *
- * @detail This contains e.g. the node ID, name, default channel and so on
+ * @details This contains e.g. the node ID, name, default channel and so on
  */
 extern config_t sysconfig;
 

core/include/kernel_internal.h

@@ -35,6 +35,9 @@ void kernel_init(void);
  */
 void board_init(void);
 
+/**
+ * @brief Prototype for a thread entry function
+ */
 typedef void *(*thread_task_func_t)(void *arg);
 
 /**

core/include/kernel_types.h

@@ -29,6 +29,9 @@
 #   include <stddef.h>
 #   include <sys/types.h>
 
+/**
+ * @brief Maximum value for ssize_t
+ */
 #   ifndef SSIZE_MAX
 #       ifdef _POSIX_SSIZE_MAX
 #           define SSIZE_MAX _POSIX_SSIZE_MAX
@@ -96,3 +99,4 @@ static inline int pid_is_valid(kernel_pid_t pid)
 #endif
 
 #endif /* KERNEL_TYPES_H */
+/** @} */

core/include/lifo.h

@@ -14,7 +14,7 @@
  * @brief   LIFO buffer API, read long description carefully
  * @author  Heiko Will <hwill@inf.fu-berlin.de>
  *
- * @detail  This LIFO implementation very efficiently handles integer values.
+ * @details This LIFO implementation very efficiently handles integer values.
  *          The caveat is that it **can only handle values between 0 and its own
  *          size - 1**. Also it can only handle up to one element of each value.
  *          If you insert a value twice the LIFO will break.

core/include/thread.h

@@ -10,6 +10,7 @@
  * @defgroup    core_thread Threading
  * @ingroup     core
  * @brief       Support for multi-threading
+ *
  * @{
  *
  * @file        thread.h
@@ -29,10 +30,13 @@
  extern "C" {
 #endif
 
+/**
+ * @brief Describes an illegal thread status
+ */
 #define STATUS_NOT_FOUND (-1)
 
 /**
- * @name Minimum stack size
+ * @brief Minimum stack size
  */
 #ifndef MINIMUM_STACK_SIZE
 #define MINIMUM_STACK_SIZE  (sizeof(tcb_t))
@@ -163,5 +167,5 @@ uintptr_t thread_measure_stack_free(char *stack);
 }
 #endif
 
-/* @} */
+/** @} */
 #endif /* __THREAD_H */

sys/include/vtimer.h

@@ -8,7 +8,7 @@
  * General Public License v2.1. See the file LICENSE in the top level
  * directory for more details.
  *
- * @ingroup  sys_vtimer
+ * @defgroup  sys_vtimer
  * @{
  * @file        vtimer.h
  * @author Kaspar Schleiser <kaspar@schleiser.de>