doc: fix linux specific documentation tags
authorFerry Huberts <ferry.huberts@pelagic.nl>
Wed, 5 Dec 2012 23:01:58 +0000 (00:01 +0100)
committerFerry Huberts <ferry.huberts@pelagic.nl>
Thu, 6 Dec 2012 00:02:24 +0000 (01:02 +0100)
Signed-off-by: Ferry Huberts <ferry.huberts@pelagic.nl>
gui/linux-gtk/src/nodes.c
src/linux/kernel_routes_nl.c
src/linux/kernel_tunnel.c
src/linux/net.c

index f407209..ecd7d41 100644 (file)
@@ -159,6 +159,7 @@ update_timer_node(union olsr_ip_addr *node, olsr_u8_t vtime)
  *registered.
  *@param node the node that has chosen the MPR
  *@param mpr the MPR chosen by the node
+ *@param vtime the expiration time
  *@return 0 if node was added, 1 if not
  */
 int
@@ -338,6 +339,7 @@ add_hna_node(union olsr_ip_addr *node, union olsr_ip_addr *net, union olsr_ip_ad
  *
  *@param node the node that has chosen an MPR
  *@param mpr the MPR choosen by node
+ *@param tmp_timer the expiration time
  *@return negative if node already registered or node not found
  */
 int
index 1e45930..aac38a9 100644 (file)
@@ -591,7 +591,7 @@ static int olsr_os_process_rt_entry(int af_family, const struct rt_entry *rt, bo
 /**
  * Insert a route in the kernel routing table
  *
- * @param destination the route to add
+ * @param rt the route to add
  *
  * @return negative on error
  */
@@ -605,7 +605,7 @@ olsr_ioctl_add_route(const struct rt_entry *rt)
 /**
  *Insert a route in the kernel routing table
  *
- *@param destination the route to add
+ *@param rt the route to add
  *
  *@return negative on error
  */
@@ -619,7 +619,7 @@ olsr_ioctl_add_route6(const struct rt_entry *rt)
 /**
  *Remove a route from the kernel
  *
- *@param destination the route to remove
+ *@param rt the route to remove
  *
  *@return negative on error
  */
@@ -633,7 +633,7 @@ olsr_ioctl_del_route(const struct rt_entry *rt)
 /**
  *Remove a route from the kernel
  *
- *@param destination the route to remove
+ *@param rt the route to remove
  *
  *@return negative on error
  */
index 973570d..4c63372 100644 (file)
@@ -248,6 +248,7 @@ struct olsr_iptunnel_entry *olsr_os_add_ipip_tunnel(union olsr_ip_addr *target,
  * Release an olsr ipip tunnel. Tunnel will be deleted
  * if this was the last user
  * @param t pointer to olsr_iptunnel_entry
+ * @param cleanup true to free t's memory
  */
 static void internal_olsr_os_del_ipip_tunnel(struct olsr_iptunnel_entry *t, bool cleanup) {
   if (!cleanup) {
index 89efb5e..50e8372 100644 (file)
@@ -359,7 +359,7 @@ net_os_restore_ifoptions(void)
 
 /**
  *Creates a blocking tcp socket for communication with switch daemon.
- *@param sa sockaddr struct. Used for bind(2).
+ *@param pin sockaddr struct. Used for bind(2).
  *@return the FD of the socket or -1 on error.
  */
 int
@@ -396,7 +396,8 @@ gethemusocket(struct sockaddr_in *pin)
 
 /**
  *Creates a nonblocking broadcast socket.
- *@param sa sockaddr struct. Used for bind(2).
+ *@param bufspace the number of bytes in the buffer
+ *@param ifp interface struct. Used for bind(2).
  *@return the FD of the socket or -1 on error.
  */
 int
@@ -480,7 +481,8 @@ getsocket(int bufspace, struct interface *ifp)
 
 /**
  *Creates a nonblocking IPv6 socket
- *@param sin sockaddr_in6 struct. Used for bind(2).
+ *@param bufspace the number of bytes in the buffer
+ *@param ifp interface struct. Used for bind(2).
  *@return the FD of the socket or -1 on error.
  */
 int