Merge pull request #696 from sieben/doc

Correct several doxygen tags (\file,...)

core/net/ip/uip.h

@@ -185,7 +185,7 @@ typedef uip_eth_addr uip_lladdr_t;
 
  uip_ipaddr(&addr, 192,168,1,2);
  uip_sethostaddr(&addr);
- 
+
  \endcode
  * \param addr A pointer to an IP address of type uip_ipaddr_t;
  *
@@ -851,7 +851,7 @@ CCIF void uip_send(const void *data, int len);
  \code
  uip_ipaddr_t addr;
  struct uip_udp_conn *c;
- 
+
  uip_ipaddr(&addr, 192,168,2,1);
  c = uip_udp_new(&addr, UIP_HTONS(12345));
  if(c != NULL) {
@@ -912,7 +912,7 @@ struct uip_udp_conn *uip_udp_new(const uip_ipaddr_t *ripaddr, uint16_t rport);
  * These functions can be used for converting between different data
  * formats used by uIP.
  */
- 
+
 /**
  * Convert an IP address to four bytes separated by commas.
  *
@@ -938,7 +938,7 @@ struct uip_udp_conn *uip_udp_new(const uip_ipaddr_t *ripaddr, uint16_t rport);
  \code
  uip_ipaddr_t ipaddr;
  struct uip_conn *c;
- 
+
  uip_ipaddr(&ipaddr, 192,168,1,2);
  c = uip_connect(&ipaddr, UIP_HTONS(80));
  \endcode
@@ -1336,11 +1336,11 @@ extern uint16_t uip_urglen, uip_surglen;
  */
 struct uip_conn {
   uip_ipaddr_t ripaddr;   /**< The IP address of the remote host. */
-  
+
   uint16_t lport;        /**< The local TCP port, in network byte order. */
   uint16_t rport;        /**< The local remote TCP port, in network byte
 			 order. */
-  
+
   uint8_t rcv_nxt[4];    /**< The sequence number that we expect to
 			 receive next. */
   uint8_t snd_nxt[4];    /**< The sequence number that was last sent by
@@ -1443,7 +1443,7 @@ struct uip_stats {
 			     layer. */
     uip_stats_t sent;     /**< Number of sent packets at the IP
 			     layer. */
-    uip_stats_t forwarded;/**< Number of forwarded packets at the IP 
+    uip_stats_t forwarded;/**< Number of forwarded packets at the IP
 			     layer. */
     uip_stats_t drop;     /**< Number of dropped packets at the IP
 			     layer. */
@@ -1572,14 +1572,14 @@ uip_ext_hdr_options_process(); */
  * The actual uIP function which does all the work.
  */
 void uip_process(uint8_t flag);
-  
+
   /* The following flags are passed as an argument to the uip_process()
    function. They are used to distinguish between the two cases where
    uip_process() is called. It can be called either because we have
    incoming data that should be processed, or because the periodic
    timer has fired. These values are never used directly, but only in
    the macros defined in this file. */
- 
+
 #define UIP_DATA          1     /* Tells uIP that there is incoming
 				   data in the uip_buf buffer. The
 				   length of the data is stored in the
@@ -1606,7 +1606,7 @@ void uip_process(uint8_t flag);
 #define UIP_TIME_WAIT   7
 #define UIP_LAST_ACK    8
 #define UIP_TS_MASK     15
-  
+
 #define UIP_STOPPED      16
 
 /* The TCP and IP headers. */
@@ -1631,7 +1631,7 @@ struct uip_tcpip_hdr {
   uint16_t ipchksum;
   uip_ipaddr_t srcipaddr, destipaddr;
 #endif /* UIP_CONF_IPV6 */
-  
+
   /* TCP header. */
   uint16_t srcport,
     destport;
@@ -1667,7 +1667,7 @@ struct uip_icmpip_hdr {
   uint16_t ipchksum;
   uip_ipaddr_t srcipaddr, destipaddr;
 #endif /* UIP_CONF_IPV6 */
-  
+
   /* ICMP header. */
   uint8_t type, icode;
   uint16_t icmpchksum;
@@ -1700,7 +1700,7 @@ struct uip_udpip_hdr {
   uint16_t ipchksum;
   uip_ipaddr_t srcipaddr, destipaddr;
 #endif /* UIP_CONF_IPV6 */
-  
+
   /* UDP header. */
   uint16_t srcport,
     destport;
@@ -2035,7 +2035,7 @@ CCIF extern uip_lladdr_t uip_lladdr;
    (((a)->u8[12]) == 0xFF))
 
 /**
- * \briefput in b the solicited node address corresponding to address a
+ * \brief put in b the solicited node address corresponding to address a
  * both a and b are of type uip_ipaddr_t*
  * */
 #define uip_create_solicited_node(a, b)    \
@@ -2086,7 +2086,7 @@ CCIF extern uip_lladdr_t uip_lladdr;
    (((a)->u8[13]) == (m)->addr[3]) &&            \
    (((a)->u8[14]) == (m)->addr[4]) &&            \
    (((a)->u8[15]) == (m)->addr[5]))
-   
+
 #endif /*UIP_CONF_LL_802154*/
 
 /**

core/sys/lc.h

@@ -51,7 +51,7 @@
  */
 
 /**
- * \file lc.h
+ * \file core/sys/lc.h
  * Local continuations
  * \author
  * Adam Dunkels <adam@sics.se>

cpu/pic32/clock.c

@@ -1,13 +1,13 @@
 /*
  * Contiki PIC32 Port project
- * 
+ *
  * Copyright (c) 2012,
  *  Scuola Superiore Sant'Anna (http://www.sssup.it) and
  *  Consorzio Nazionale Interuniversitario per le Telecomunicazioni
  *  (http://www.cnit.it).
  *
  * All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
@@ -41,7 +41,7 @@
  */
 
 /**
- * \file   clock.c
+ * \file   cpu/pic32/clock.c
  * \brief  Clock routines.
  * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
  * \author Daniele Alessandrelli <d.alessandrelli@sssup.it>
@@ -129,7 +129,7 @@ clock_delay_usec(uint16_t dt)
   uint32_t stop;
 
   asm volatile("mfc0   %0, $9" : "=r"(now));
-  
+
   /* The Count register is incremented every two system clock (SYSCLK) cycles. */
 
   stop = now + dt * ((pic32_clock_get_system_clock() / 1000000) / 2);

cpu/pic32/debug-uart.c

@@ -1,13 +1,13 @@
 /*
  * Contiki PIC32 Port project
- * 
+ *
  * Copyright (c) 2012,
  *  Scuola Superiore Sant'Anna (http://www.sssup.it) and
  *  Consorzio Nazionale Interuniversitario per le Telecomunicazioni
  *  (http://www.cnit.it).
  *
  * All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
@@ -41,7 +41,7 @@
  */
 
 /**
- * \file   debug-uart.h
+ * \file   cpu/pic32/debug-uart.h
  * \brief  Debug output redirection to uart.
  * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
  * \date   2012-03-21

cpu/pic32/debug-uart.h

@@ -1,13 +1,13 @@
 /*
  * Contiki PIC32 Port project
- * 
+ *
  * Copyright (c) 2012,
  *  Scuola Superiore Sant'Anna (http://www.sssup.it) and
  *  Consorzio Nazionale Interuniversitario per le Telecomunicazioni
  *  (http://www.cnit.it).
  *
  * All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
@@ -41,7 +41,7 @@
  */
 
 /**
- * \file   debug-uart.h
+ * \file   cpu/pic32/debug-uart.h
  * \brief  Debug output redirection to uart.
  * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
  * \date   2012-03-21

cpu/pic32/dev/uart1.h

@@ -1,13 +1,13 @@
 /*
  * Contiki PIC32 Port project
- * 
+ *
  * Copyright (c) 2012,
  *  Scuola Superiore Sant'Anna (http://www.sssup.it) and
  *  Consorzio Nazionale Interuniversitario per le Telecomunicazioni
  *  (http://www.cnit.it).
  *
  * All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
@@ -34,8 +34,8 @@
  *
  */
 
-/** 
- * @file uart1.h
+/**
+ * @file cpu/pic32/dev/uart1.h
  * @brief UART1 routines
  * @author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
  *

cpu/pic32/mtarch.h

@@ -1,13 +1,13 @@
 /*
  * Contiki PIC32 Port project
- * 
+ *
  * Copyright (c) 2012,
  *  Scuola Superiore Sant'Anna (http://www.sssup.it) and
  *  Consorzio Nazionale Interuniversitario per le Telecomunicazioni
  *  (http://www.cnit.it).
  *
  * All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
@@ -40,8 +40,8 @@
  * @{
  */
 
-/** 
- * \file   mtarch.h
+/**
+ * \file   cpu/pic32/mtarch.h
  * \brief  Implementation of multithreading in PIC32. To be done.
  * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
  * \date   2012-03-23

cpu/pic32/pic32.c

@@ -1,13 +1,13 @@
 /*
  * Contiki PIC32 Port project
- * 
+ *
  * Copyright (c) 2012,
  *  Scuola Superiore Sant'Anna (http://www.sssup.it) and
  *  Consorzio Nazionale Interuniversitario per le Telecomunicazioni
  *  (http://www.cnit.it).
  *
  * All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
@@ -40,8 +40,8 @@
  * @{
  */
 
-/** 
- * \file   mtarch.h
+/**
+ * \file   cpu/pic32/mtarch.h
  * \brief  PIC32MX initialization routines
  * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
  * \author Daniele Alessandrelli <d.alessandrelli@sssup.it>
@@ -50,7 +50,7 @@
 
 /*
  * PIC32MX795F512L - Specific Functions
- * 
+ *
  * All the functions in this part of the file are specific for the
  * pic32mx795f512l that is characterized by registers' name that differ from
  * the 3xx and 4xx families of the pic32mx.
@@ -59,7 +59,7 @@
 #include <pic32_irq.h>
 
 #include <p32xxxx.h>
-#include <peripheral/system.h> 
+#include <peripheral/system.h>
 #include <stdint.h>
 
 #include <dev/leds.h>
@@ -106,10 +106,10 @@ pic32_init(void)
   SYSKEY = 0;
   SYSKEY = 0xaa996655;
   SYSKEY = 0x556699aa;
-  
+
   /* Enable Sleep Mode */
   OSCCONCLR = 1 << _OSCCON_SLPEN_POSITION;
-  
+
   SYSKEY = 0;
 
   ASM_EN_INT;
@@ -125,7 +125,7 @@ _general_exception_handler(void)
   asm volatile ("mfc0 %0,$13":"=r" (cp0_exception_cause));
 
   cp0_exception_code = (cp0_exception_cause >> 2) & 0x0000001F;
-  
+
   leds_on(LEDS_ALL);
 
   while(1){

cpu/pic32/rtimer-arch.c

@@ -1,13 +1,13 @@
 /*
  * Contiki PIC32 Port project
- * 
+ *
  * Copyright (c) 2012,
  *  Scuola Superiore Sant'Anna (http://www.sssup.it) and
  *  Consorzio Nazionale Interuniversitario per le Telecomunicazioni
  *  (http://www.cnit.it).
  *
  * All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
@@ -41,15 +41,15 @@
  */
 
 /**
- * \file   rtimer-arch.c
+ * \file   cpu/pic32/rtimer-arch.c
  * \brief  PIC32MX RTIMER routines
  * \author Giovanni Pellerano <giovanni.pellerano@evilaliv3.org>
  * \date   2012-04-11
  */
 
 /*
  * PIC32MX795F512L - Specific Functions
- * 
+ *
  * All the functions in this part of the file are specific for the
  * pic32mx795f512l that is characterized by registers' name that differ from
  * the 3xx and 4xx families of the pic32mx.
@@ -85,7 +85,7 @@ rtimer_arch_init(void)
   IPC3CLR = _IPC3_T3IP_MASK | _IPC3_T3IS_MASK;
   IPC3SET = (7 << _IPC3_T3IP_POSITION) | (3 << _IPC3_T3IS_POSITION);
   T2CON = 0;
-  T3CON = 0;     
+  T3CON = 0;
   T2CONSET = _T2CON_T32_MASK | (TIMER_B_PRESCALE_256 << _T2CON_TCKPS_POSITION);
   PR2 =  0xFFFFFFFF;
   TMR2 = 0;