Merge pull request contiki-os#1344 from tsparber/fix-doxygen

doxygen: Fixed all warnings

Author: simonduq

.gitignore

@@ -32,6 +32,8 @@
 *.report
 summary
 *.summary
+*.runerr
+*.runlog
 *.faillog
 *.orig
 *~

apps/program-handler/program-handler.c

@@ -246,6 +246,7 @@ program_handler_load(char *name, char *arg)
 #else /* WITH_LOADER_ARCH */
 #define RUN(prg, process, arg) process_start(process, arg)
 #endif /* WITH_LOADER_ARCH */
+#if CTK_CONF_SCREENSAVER
 /*-----------------------------------------------------------------------------------*/
 /**
  * Configures the name of the screensaver to be loaded when
@@ -255,7 +256,6 @@ program_handler_load(char *name, char *arg)
  * should be used.
  */
 /*-----------------------------------------------------------------------------------*/
-#if CTK_CONF_SCREENSAVER
 void
 program_handler_setscreensaver(char *name)
 {

core/net/ip/uip.h

@@ -136,15 +136,18 @@ typedef struct uip_eth_addr {
 typedef uip_802154_longaddr uip_lladdr_t;
 #define UIP_802154_SHORTADDR_LEN 2
 #define UIP_802154_LONGADDR_LEN  8
+/** \brief Link layer address length */
 #define UIP_LLADDR_LEN UIP_802154_LONGADDR_LEN
 #else /*UIP_CONF_LL_802154*/
 #if UIP_CONF_LL_80211
 /** \brief 802.11 address */
 typedef uip_80211_addr uip_lladdr_t;
+/** \brief Link layer address length */
 #define UIP_LLADDR_LEN 6
 #else /*UIP_CONF_LL_80211*/
 /** \brief Ethernet address */
 typedef uip_eth_addr uip_lladdr_t;
+/** \brief Link layer address length */
 #define UIP_LLADDR_LEN 6
 #endif /*UIP_CONF_LL_80211*/
 #endif /*UIP_CONF_LL_802154*/
@@ -1368,8 +1371,7 @@ struct uip_conn {
   uint8_t nrtx;          /**< The number of retransmissions for the last
                               segment sent. */
 
-  /** The application state. */
-  uip_tcp_appstate_t appstate;
+  uip_tcp_appstate_t appstate; /** The application state. */
 };
 
 

core/net/ipv6/sicslowpan.c

@@ -1046,12 +1046,14 @@ uncompress_hdr_hc06(uint16_t ip_len)
  *   - Both src and dest interface ID are recoverable from lower layer
  *     header
  *   - Next header is either ICMP, UDP or TCP
+ *
  * Moreover, if next header is UDP, we try to compress it using HC_UDP.
- * This is feasible is both ports are between F0B0 and F0B0 + 15\n\n
+ * This is feasible is both ports are between F0B0 and F0B0 + 15.
+ *
  *
  * Resulting header structure:
- * - For ICMP, TCP, non compressed UDP\n
- *   HC1 encoding = 11111010 (UDP) 11111110 (TCP) 11111100 (ICMP)\n
+ *   - For ICMP, TCP, non compressed UDP\n
+ *     HC1 encoding = 11111010 (UDP) 11111110 (TCP) 11111100 (ICMP)\n
  * \verbatim
  *                      1                   2                   3
  * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
@@ -1062,8 +1064,8 @@ uncompress_hdr_hc06(uint16_t ip_len)
  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  * \endverbatim
  *
- * - For compressed UDP
- *   HC1 encoding = 11111011, HC_UDP encoding = 11100000\n
+ *   - For compressed UDP\n
+ *     HC1 encoding = 11111011, HC_UDP encoding = 11100000\n
  * \verbatim
  *                      1                   2                   3
  * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
@@ -1577,7 +1579,6 @@ output(const uip_lladdr_t *localdest)
 
 /*--------------------------------------------------------------------*/
 /** \brief Process a received 6lowpan packet.
- *  \param r The MAC layer
  *
  *  The 6lowpan packet is put in packetbuf by the MAC. If its a frag1 or
  *  a non-fragmented packet we first uncompress the IP header. The

core/net/ipv6/uip-ds6-nbr.c

@@ -231,10 +231,10 @@ uip_ds6_link_neighbor_callback(int status, int numtx)
 
 }
 /*---------------------------------------------------------------------------*/
+/** Periodic processing on neighbors */
 void
 uip_ds6_neighbor_periodic(void)
 {
-  /* Periodic processing on neighbors */
   uip_ds6_nbr_t *nbr = nbr_table_head(ds6_neighbors);
   while(nbr != NULL) {
     switch(nbr->state) {

core/net/ipv6/uip-ds6.c

@@ -53,23 +53,23 @@
 #define DEBUG DEBUG_NONE
 #include "net/ip/uip-debug.h"
 
-struct etimer uip_ds6_timer_periodic;                           /** \brief Timer for maintenance of data structures */
+struct etimer uip_ds6_timer_periodic;                           /**< Timer for maintenance of data structures */
 
 #if UIP_CONF_ROUTER
-struct stimer uip_ds6_timer_ra;                                 /** \brief RA timer, to schedule RA sending */
+struct stimer uip_ds6_timer_ra;                                 /**< RA timer, to schedule RA sending */
 #if UIP_ND6_SEND_RA
-static uint8_t racount;                                         /** \brief number of RA already sent */
-static uint16_t rand_time;                                      /** \brief random time value for timers */
+static uint8_t racount;                                         /**< number of RA already sent */
+static uint16_t rand_time;                                      /**< random time value for timers */
 #endif
 #else /* UIP_CONF_ROUTER */
-struct etimer uip_ds6_timer_rs;                                 /** \brief RS timer, to schedule RS sending */
-static uint8_t rscount;                                         /** \brief number of rs already sent */
+struct etimer uip_ds6_timer_rs;                                 /**< RS timer, to schedule RS sending */
+static uint8_t rscount;                                         /**< number of rs already sent */
 #endif /* UIP_CONF_ROUTER */
 
 /** \name "DS6" Data structures */
 /** @{ */
-uip_ds6_netif_t uip_ds6_if;                                       /** \brief The single interface */
-uip_ds6_prefix_t uip_ds6_prefix_list[UIP_DS6_PREFIX_NB];          /** \brief Prefix list */
+uip_ds6_netif_t uip_ds6_if;                                     /**< The single interface */
+uip_ds6_prefix_t uip_ds6_prefix_list[UIP_DS6_PREFIX_NB];        /**< Prefix list */
 
 /* Used by Cooja to enable extraction of addresses from memory.*/
 uint8_t uip_ds6_addr_size;

core/net/ipv6/uip-ds6.h

@@ -282,6 +282,7 @@ uint8_t uip_ds6_is_addr_onlink(uip_ipaddr_t *ipaddr);
 
 /** \name Unicast address list basic routines */
 /** @{ */
+/** \brief Add a unicast address to the interface */
 uip_ds6_addr_t *uip_ds6_addr_add(uip_ipaddr_t *ipaddr,
                                  unsigned long vlifetime, uint8_t type);
 void uip_ds6_addr_rm(uip_ds6_addr_t *addr);

core/net/ipv6/uip-nd6.c

@@ -811,7 +811,7 @@ uip_nd6_rs_output(void)
   return;
 }
 /*---------------------------------------------------------------------------*/
-/*
+/**
  * Process a Router Advertisement
  *
  * - Possible actions when receiving a RA: add router to router list,

core/net/ipv6/uip-nd6.h

@@ -59,9 +59,12 @@
 
 /** \name RFC 4861 Host constant */
 /** @{ */
+/** \brief Maximum router solicitation delay */
 #define UIP_ND6_MAX_RTR_SOLICITATION_DELAY 1
+/** \brief Router solicitation interval */
 #define UIP_ND6_RTR_SOLICITATION_INTERVAL  4
-#define UIP_ND6_MAX_RTR_SOLICITATIONS	   3
+/** \brief Maximum router solicitations */
+#define UIP_ND6_MAX_RTR_SOLICITATIONS      3
 /** @} */
 
 /** \name RFC 4861 Router constants */

core/net/ipv6/uip6.c

@@ -654,7 +654,7 @@ static uint8_t uip_reassflags;
  */
 
 
-struct etimer uip_reass_timer; /* timer for reassembly */
+struct etimer uip_reass_timer; /**< Timer for reassembly */
 uint8_t uip_reass_on; /* equal to 1 if we are currently reassembling a packet */
 
 static uint32_t uip_id; /* For every packet that is to be fragmented, the source

cpu/arm/aducrf101/Common/ADuCRF101.h

@@ -33,7 +33,7 @@
  */
 
 /****************************************************************************************************//**
- * @file     ADUCRF101.h
+ * @file     ADuCRF101.h
  *
  * @brief    CMSIS Cortex-M3 Core Peripheral Access Layer Header File for
  *           default ADUCRF101 Device Series

cpu/arm/aducrf101/Common/radioeng.c

@@ -1292,7 +1292,6 @@ static RIE_Responses  RadioWaitOnState(RadioState FinalState)
 /**
     @fn      RIE_Responses  RadioWaitOnCmdLdr(void)
     @brief   Wait for Final State to be reached
-    @param   FinalState    State to wait on
     @return  RIE_Responses  Error code
 **/
 static RIE_Responses  RadioWaitOnCmdLdr(void)

cpu/arm/aducrf101/Common/system_ADuCRF101.c

@@ -32,7 +32,7 @@
  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 /**
-@file     system_ADUCRF101.c
+@file     system_ADuCRF101.c
 @brief    CMSIS Cortex-M3 Device Peripheral Access Layer Implementation File
           for the ADuCRF101
 @version  v1.0
@@ -106,7 +106,6 @@ void SystemCoreClockUpdate (void)            /* Get Core Clock Frequency     */
 /**
  * Initialize the system
  *
- * @param  none
  * @return none
  *
  * @brief  Setup the microcontroller system.

cpu/arm/aducrf101/Common/system_ADuCRF101.h

@@ -32,7 +32,7 @@
  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 /**
-@file     system_ADUCRF101.h
+@file     system_ADuCRF101.h
 @brief:   CMSIS Cortex-M3 Device Peripheral Access Layer Header File
           for the ADuCRF101
 @version  v0.2
@@ -51,7 +51,6 @@
 /**
  * @brief  Initialize the system
  *
- * @param  none
  * @return none
  *
  * Setup the microcontroller system.
@@ -62,7 +61,6 @@ extern void SystemInit (void);
 /**
  * @brief  Update internal SystemCoreClock variable
  *
- * @param  none
  * @return none
  *
  * Updates the internal SystemCoreClock with current core

cpu/arm/at91sam7s/loader/elfloader-arch-otf.h

@@ -71,7 +71,8 @@
 
 /**
  * \brief      Perform a relocation.
- * \param output   The output object for the segment.
+ * \param input_fd The file descriptor for the ELF file.
+ * \param output The output object for the segment.
  * \param sectionoffset The file offset at which the relocation can be found.
  * \param sectionaddr The section start address (absolute runtime).
  * \param rela A pointer to an ELF32 rela structure (struct elf32_rela).

cpu/arm/at91sam7s/loader/elfloader-otf.h

@@ -169,11 +169,11 @@ struct elfloader_output {
 };
 
 /**
- * \brief	Allocate a new segment
- * \param input The output object
- * \param type	Type of segment
- * \param size	Size of segment in bytes
- * \return	A pointer to the start of the segment.
+ * \brief Allocate a new segment
+ * \param output The output object
+ * \param type   Type of segment
+ * \param size   Size of segment in bytes
+ * \return A pointer to the start of the segment.
  *
  * The returned address doesn't need to correspond to any real memory,
  * since it's only used for calculating the relocations.
@@ -182,39 +182,39 @@ void *elfloader_allocate_segment(struct elfloader_output *output,
                                  unsigned int type, int size);
 
 /**
- * \brief	Start writing to a new segment
- * \param input The output object
- * \param type	Type of segment
- * \param addr  Address of segment from elfloader_allocate_segment
- * \param size	Size of segment in bytes
- * \return	Returns ELFLOADER_OK if successful, otherwise an error code
+ * \brief Start writing to a new segment
+ * \param output The output object
+ * \param type   Type of segment
+ * \param addr   Address of segment from elfloader_allocate_segment
+ * \param size   Size of segment in bytes
+ * \return Returns ELFLOADER_OK if successful, otherwise an error code
  *
  */
 int elfloader_start_segment(struct elfloader_output *output,
                             unsigned int type, void *addr, int size);
 
 /**
- * \brief	Mark end of segment
- * \param input The output object
- * \return	Zero if successful
+ * \brief Mark end of segment
+ * \param output The output object
+ * \return Zero if successful
  */
 int elfloader_end_segment(struct elfloader_output *output);
 
 /**
- * \brief	Write data to a segment
- * \param input The output object
- * \param buf	Data to be written
- * \param len	Length of data
- * \return	The number of bytes actually written, or negative if failed.
+ * \brief Write data to a segment
+ * \param output The output object
+ * \param buf    Data to be written
+ * \param len    Length of data
+ * \return The number of bytes actually written, or negative if failed.
  */
 int elfloader_write_segment(struct elfloader_output *output, const char *buf,
                             unsigned int len);
 
 /**
- * \brief	Get the current offset in the file where the next data will
- *		be written.
- * \param input The output object
- * \return	The current offset.
+ * \brief Get the current offset in the file where the next data will
+ * be written.
+ * \param output The output object
+ * \return The current offset.
  */
 unsigned int elfloader_segment_offset(struct elfloader_output *output);
 
@@ -255,8 +255,8 @@ void elfloader_init(void);
 
 /**
  * \brief      Load and relocate an ELF file.
- * \param input Input object defining how to read from the ELF file
- * \param output Output object defining how to create and write to seegments.
+ * \param input_fd Input object defining how to read from the ELF file
+ * \param output   Output object defining how to create and write to seegments.
  * \return     ELFLOADER_OK if loading and relocation worked.
  *             Otherwise an error value.
  *