doc: fix common documentation tags
authorFerry Huberts <ferry.huberts@pelagic.nl>
Wed, 5 Dec 2012 22:36:38 +0000 (23:36 +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>
21 files changed:
src/build_msg.c
src/gateway.c
src/hna_set.c
src/interfaces.c
src/ipc_frontend.c
src/kernel_routes.h
src/link_set.c
src/lq_plugin.c
src/main.c
src/mid_set.c
src/mpr_selector_set.c
src/neighbor_table.c
src/net_os.h
src/olsr.c
src/parser.c
src/plugin_loader.c
src/process_package.c
src/routing_table.c
src/scheduler.c
src/tc_set.c
src/two_hop_neighbor_table.c

index 0401759..109f955 100644 (file)
@@ -178,7 +178,7 @@ queue_tc(struct tc_message * message, struct interface * ifp)
  *Build a MID message to the outputbuffer
  *
  *<b>NO INTERNAL BUFFER</b>
- *@param ifn use this interfaces address as main address
+ *@param ifp a pointer to the interface with the main address
  *@return 1 on success
  */
 
index e0f3f64..c7bdcd2 100644 (file)
@@ -582,7 +582,7 @@ bool olsr_set_inet_gateway(union olsr_ip_addr *originator, bool ipv4, bool ipv6)
 }
 
 /**
- * @param if set to true then the IPv6 gateway is returned, otherwise the IPv4
+ * @param ipv6 if set to true then the IPv6 gateway is returned, otherwise the IPv4
  * gateway is returned
  * @return a pointer to the gateway_entry of the current ipv4 internet gw or
  * NULL if not set.
index 13d0dc3..df8a82d 100644 (file)
@@ -96,7 +96,7 @@ olsr_cleanup_hna(union olsr_ip_addr *orig) {
  *
  * @param nets the network list to look in
  * @param net the network to look for
- * @param mask the netmask to look for
+ * @param prefixlen the prefix length
  *
  * @return the localized entry or NULL of not found
  */
@@ -177,8 +177,8 @@ olsr_add_hna_entry(const union olsr_ip_addr *addr)
  * Adds a network entry to a HNA gateway.
  *
  * @param hna_gw the gateway entry to add the network to
- * @param net the networkaddress to add
- * @param mask the netmask
+ * @param net the network address to add
+ * @param prefixlen the prefix length
  *
  * @return the newly created entry
  */
@@ -266,10 +266,8 @@ olsr_expire_hna_net_entry(void *context)
  *
  *@param gw address of the gateway
  *@param net address of the network
- *@param mask the netmask
+ *@param prefixlen the prefix length
  *@param vtime the validitytime of the entry
- *
- *@return nada
  */
 void
 olsr_update_hna_entry(const union olsr_ip_addr *gw, const union olsr_ip_addr *net, uint8_t prefixlen, olsr_reltime vtime)
@@ -357,6 +355,8 @@ olsr_print_hna_set(void)
  *Forwards the message if that is to be done.
  *
  *@param m the incoming OLSR message
+ *@param in_if the incoming interface
+ *@param from_addr the originator address
  *the OLSR message.
  *@return 1 on success
  */
index 832e1c1..befc94c 100644 (file)
@@ -166,9 +166,9 @@ if_ifwithaddr(const union olsr_ip_addr *addr)
 }
 
 /**
- *Find the interface with a given number.
+ *Find the interface with a given file descriptor/socket.
  *
- *@param nr the number of the interface to find.
+ *@param fd file descriptor/socket of the interface to find.
  *
  *@return return the interface struct representing the interface
  *that matched the number.
@@ -235,7 +235,7 @@ olsrif_ifwithname(const char *if_name)
 /**
  *Find the interface with a given interface index.
  *
- *@param iif_index of the interface to find.
+ *@param if_index index of the interface to find.
  *
  *@return return the interface struct representing the interface
  *that matched the iif_index.
@@ -256,7 +256,7 @@ if_ifwithindex(const int if_index)
 /**
  *Get an interface name for a given interface index
  *
- *@param iif_index of the interface to find.
+ *@param if_index index of the interface to find.
  *
  *@return "" or interface name.
  */
@@ -272,8 +272,9 @@ if_ifwithindex_name(const int if_index)
  *name and insert it into the interface list.
  *
  *@param name the name of the interface.
+ *@param hemu non-zero to indicate host emulation mode
  *
- *@return nada
+ *@return the new interf_name struct
  */
 struct olsr_if *
 olsr_create_olsrif(const char *name, int hemu)
@@ -316,9 +317,9 @@ olsr_create_olsrif(const char *name, int hemu)
  *Add an ifchange function. These functions are called on all (non-initial)
  *changes in the interface set.
  *
- *@param
+ *@param f a callback function
  *
- *@return
+ *@return always 1
  */
 int
 olsr_add_ifchange_handler(void (*f) (int if_index, struct interface *, enum olsr_ifchg_flag))
index 443fb0e..5203e2d 100644 (file)
@@ -185,7 +185,9 @@ ipc_check_allowed_ip(const union olsr_ip_addr *addr)
 /**
  *Sends a olsr packet on the IPC socket.
  *
- *@param olsr the olsr struct representing the packet
+ *@param msg the olsr struct representing the packet
+ *@param in_if the incoming interface
+ *@param from_addr the sender address
  *
  *@return true for not preventing forwarding
  */
@@ -214,7 +216,9 @@ frontend_msgparser(union olsr_message * msg, struct interface * in_if __attribut
 /**
  *Send a route table update to the front-end.
  *
- *@param kernel_route a rtentry describing the route update
+ *@param dst the destination of the route
+ *@param gw the gateway for the route
+ *@param met the metric for the route
  *@param add 1 if the route is to be added 0 if it is to be deleted
  *@param int_name the name of the interface the route is set to go by
  *
index 6c7a9e7..bb4caae 100644 (file)
 #include "defs.h"
 #include "routing_table.h"
 
-int olsr_ioctl_add_route(const struct rt_entry *);
+int olsr_ioctl_add_route(const struct rt_entry *rt);
 
-int olsr_ioctl_add_route6(const struct rt_entry *);
+int olsr_ioctl_add_route6(const struct rt_entry *rt);
 
-int olsr_ioctl_del_route(const struct rt_entry *);
+int olsr_ioctl_del_route(const struct rt_entry *rt);
 
-int olsr_ioctl_del_route6(const struct rt_entry *);
+int olsr_ioctl_del_route6(const struct rt_entry *rt);
 
 #ifdef __linux__
 int rtnetlink_register_socket(int);
index 399a5ee..aa6a9ea 100644 (file)
@@ -113,7 +113,7 @@ void olsr_reset_all_links(void) {
  * Get the status of a link. The status is based upon different
  * timeouts in the link entry.
  *
- * @param remote address of the remote interface
+ * @param entry link entry
  * @return the link status of the link
  */
 int
@@ -739,8 +739,8 @@ update_link_entry(const union olsr_ip_addr *local, const union olsr_ip_addr *rem
  * one neighbor entry with another pointer
  * Used by MID updates.
  *
- * @old the pointer to replace
- * @new the pointer to use instead of "old"
+ * @param old the pointer to replace
+ * @param new the pointer to use instead of "old"
  * @return the number of entries updated
  */
 int
@@ -770,6 +770,7 @@ replace_neighbor_link_set(const struct neighbor_entry *old, struct neighbor_entr
  *looking in a received HELLO message.
  *
  *@param message the HELLO message to check
+ *@param in_if the incoming interface
  *
  *@return the link status
  */
index 6a454e6..7057faf 100644 (file)
@@ -126,8 +126,8 @@ init_lq_handler_tree(void)
  * The name parameter is marked as "unused" to squelch a compiler warning if debug
  * output is not active
  *
- * @param pointer to lq_handler structure
- * @param name of the link quality handler for debug output
+ * @param handler pointer to lq_handler structure
+ * @param name name of the link quality handler for debug output
  */
 void
 register_lq_handler(struct lq_handler *handler, const char *name)
@@ -149,7 +149,7 @@ register_lq_handler(struct lq_handler *handler, const char *name)
  *
  * this function calculates the linkcost of a tc_edge_entry
  *
- * @param pointer to the tc_edge_entry
+ * @param tc_edge pointer to the tc_edge_entry
  * @return linkcost
  */
 olsr_linkcost
@@ -165,8 +165,8 @@ olsr_calc_tc_cost(const struct tc_edge_entry * tc_edge)
  * this function converts the lq information of a lq_hello_neighbor into binary package
  * format
  *
- * @param pointer to binary buffer to write into
- * @param pointer to lq_hello_neighbor
+ * @param buff pointer to binary buffer to write into
+ * @param neigh pointer to lq_hello_neighbor
  * @return number of bytes that have been written
  */
 int
@@ -182,8 +182,8 @@ olsr_serialize_hello_lq_pair(unsigned char *buff, struct lq_hello_neighbor *neig
  * this function reads the lq information of a binary package into a hello_neighbor
  * It also initialize the cost variable of the hello_neighbor
  *
- * @param pointer to the current buffer pointer
- * @param pointer to hello_neighbor
+ * @param curr pointer to the current buffer pointer
+ * @param neigh pointer to hello_neighbor
  */
 void
 olsr_deserialize_hello_lq_pair(const uint8_t ** curr, struct hello_neighbor *neigh)
@@ -199,8 +199,8 @@ olsr_deserialize_hello_lq_pair(const uint8_t ** curr, struct hello_neighbor *nei
  * this function converts the lq information of a olsr_serialize_tc_lq_pair
  * into binary package format
  *
- * @param pointer to binary buffer to write into
- * @param pointer to olsr_serialize_tc_lq_pair
+ * @param buff pointer to binary buffer to write into
+ * @param neigh pointer to olsr_serialize_tc_lq_pair
  * @return number of bytes that have been written
  */
 int
@@ -215,8 +215,8 @@ olsr_serialize_tc_lq_pair(unsigned char *buff, struct tc_mpr_addr *neigh)
  *
  * this function reads the lq information of a binary package into a tc_edge_entry
  *
- * @param pointer to the current buffer pointer
- * @param pointer to tc_edge_entry
+ * @param curr pointer to the current buffer pointer
+ * @param edge pointer to tc_edge_entry
  */
 void
 olsr_deserialize_tc_lq_pair(const uint8_t ** curr, struct tc_edge_entry *edge)
@@ -232,8 +232,8 @@ olsr_deserialize_tc_lq_pair(const uint8_t ** curr, struct tc_edge_entry *edge)
  * is lost (timeout) or received. This way the lq-plugin can update the links link
  * quality value.
  *
- * @param pointer to link_entry
- * @param true if hello package was lost
+ * @param entry pointer to link_entry
+ * @param lost true if hello package was lost
  */
 void
 olsr_update_packet_loss_worker(struct link_entry *entry, bool lost)
@@ -248,8 +248,8 @@ olsr_update_packet_loss_worker(struct link_entry *entry, bool lost)
  * this function is called to copy the link quality information from a received
  * hello package into a link_entry.
  *
- * @param pointer to link_entry
- * @param pointer to hello_neighbor, if NULL the neighbor link quality information
+ * @param local pointer to link_entry
+ * @param foreign pointer to hello_neighbor, if NULL the neighbor link quality information
  * of the link entry has to be reset to "zero"
  */
 void
@@ -271,8 +271,8 @@ olsr_memorize_foreign_hello_lq(struct link_entry *local, struct hello_neighbor *
  * It's not thread save and should not be called twice with the same println
  * value in the same context (a single printf command for example).
  *
- * @param pointer to link_entry
- * @param char separator between LQ and NLQ
+ * @param entry to link_entry
+ * @param separator separator between LQ and NLQ
  * @param buffer for output
  * @return pointer to a buffer with the text representation
  */
@@ -290,9 +290,9 @@ get_link_entry_text(struct link_entry *entry, char separator, struct lqtextbuffe
  * It's not thread save and should not be called twice with the same println
  * value in the same context (a single printf command for example).
  *
- * @param pointer to tc_edge_entry
- * @param char separator between LQ and NLQ
- * @param pointer to buffer
+ * @param entry pointer to tc_edge_entry
+ * @param separator separator between LQ and NLQ
+ * @param buffer pointer to buffer
  * @return pointer to the buffer with the text representation
  */
 const char *
@@ -308,9 +308,9 @@ get_tc_edge_entry_text(struct tc_edge_entry *entry, char separator, struct lqtex
  * This function transforms an olsr_linkcost value into it's text representation and copies
  * the result into a buffer.
  *
- * @param linkcost value
- * @param true to transform the cost of a route, false for a link
- * @param pointer to buffer
+ * @param cost link cost value
+ * @param route true to transform the cost of a route, false for a link
+ * @param buffer pointer to buffer
  * @return pointer to buffer filled with text
  */
 const char *
@@ -336,8 +336,8 @@ get_linkcost_text(olsr_linkcost cost, bool route, struct lqtextbuffer *buffer)
  * this function copies the link quality information from a link_entry to a
  * lq_hello_neighbor.
  *
- * @param pointer to target lq_hello_neighbor
- * @param pointer to source link_entry
+ * @param target pointer to target lq_hello_neighbor
+ * @param source pointer to source link_entry
  */
 void
 olsr_copy_hello_lq(struct lq_hello_neighbor *target, struct link_entry *source)
@@ -353,8 +353,8 @@ olsr_copy_hello_lq(struct lq_hello_neighbor *target, struct link_entry *source)
  * this function copies the link quality information from a link_entry to a
  * tc_mpr_addr.
  *
- * @param pointer to tc_mpr_addr
- * @param pointer to link_entry
+ * @param target pointer to tc_mpr_addr
+ * @param source pointer to link_entry
  */
 void
 olsr_copylq_link_entry_2_tc_mpr_addr(struct tc_mpr_addr *target, struct link_entry *source)
@@ -370,8 +370,8 @@ olsr_copylq_link_entry_2_tc_mpr_addr(struct tc_mpr_addr *target, struct link_ent
  * this function copies the link quality information from a link_entry to a
  * tc_edge_entry.
  *
- * @param pointer to tc_edge_entry
- * @param pointer to link_entry
+ * @param target pointer to tc_edge_entry
+ * @param source pointer to link_entry
  */
 void
 olsr_copylq_link_entry_2_tc_edge_entry(struct tc_edge_entry *target, struct link_entry *source)
@@ -391,7 +391,7 @@ void olsr_clear_hello_lq(struct link_entry *link) {
  *
  * this function resets the linkquality value of a tc_mpr_addr
  *
- * @param pointer to tc_mpr_addr
+ * @param target pointer to tc_mpr_addr
  */
 void
 olsr_clear_tc_lq(struct tc_mpr_addr *target)
@@ -499,9 +499,6 @@ size_t olsr_sizeof_tc_lqdata(void) {
 /**
  * This function should be called whenever the current linkcost
  * value changed in a relevant way.
- *
- * @param link pointer to current link
- * @param newcost new cost of this link
  */
 void olsr_relevant_linkcost_change(void) {
   changes_neighborhood = true;
index 2d9b3a5..99d1a43 100644 (file)
@@ -93,7 +93,7 @@ static void olsr_shutdown(int) __attribute__ ((noreturn));
 /*
  * Local function prototypes
  */
-void olsr_reconfigure(int) __attribute__ ((noreturn));
+void olsr_reconfigure(int signo) __attribute__ ((noreturn));
 
 static void print_usage(bool error);
 
@@ -663,12 +663,12 @@ int main(int argc, char *argv[]) {
   return 1;
 } /* main */
 
+#ifndef _WIN32
 /**
  * Reconfigure olsrd. Currently kind of a hack...
  *
- *@param signal the signal that triggered this callback
+ *@param signo the signal that triggered this callback
  */
-#ifndef _WIN32
 void olsr_reconfigure(int signo __attribute__ ((unused))) {
   /* if we are started with -nofork, we do not want to go into the
    * background here. So we can simply stop on -HUP
@@ -723,7 +723,7 @@ static void olsr_shutdown_messages(void) {
 /**
  *Function called at shutdown. Signal handler
  *
- * @param signal the signal that triggered this call
+ * @param signo the signal that triggered this call
  */
 #ifdef _WIN32
 int __stdcall
index 2e05106..c25e0bf 100644 (file)
@@ -144,6 +144,7 @@ olsr_set_mid_timer(struct mid_entry *mid, olsr_reltime rel_timer)
  *
  * @param m_addr the main address of the node
  * @param alias the alias address to insert
+ * @param vtime the expiration time
  * @return false if mid_address is unnecessary, true otherwise
  */
 
@@ -252,8 +253,7 @@ insert_mid_tuple(union olsr_ip_addr *m_addr, struct mid_address *alias, olsr_rel
  *
  * @param main_add the main address of the node
  * @param alias the alias address to insert
- * @param seq the sequence number to register a new node with
- * @return nada
+ * @param vtime the expiration time
  */
 void
 insert_mid_alias(union olsr_ip_addr *main_add, const union olsr_ip_addr *alias, olsr_reltime vtime)
@@ -378,6 +378,7 @@ mid_lookup_aliases(const union olsr_ip_addr *adr)
  * Update the timer for an MID entry
  *
  * @param adr the main address of the entry
+ * @param vtime the expiration time
  * @return 1 if the node was updated, 0 if not
  */
 int
@@ -405,9 +406,7 @@ olsr_update_mid_table(const union olsr_ip_addr *adr, olsr_reltime vtime)
 /**
  * Remove aliases from 'entry' which are not listed in 'declared_aliases'.
  *
- * @param entry the MID entry
- * @param declared_aliases the list of declared aliases for the MID entry
- * @return nada
+ * @param message the MID message
  */
 static void
 olsr_prune_aliases(struct mid_message *message)
@@ -489,7 +488,7 @@ olsr_prune_aliases(struct mid_message *message)
 /**
  * Delete a MID entry
  *
- * @param entry the entry to delete
+ * @param mid the entry to delete
  */
 void
 olsr_delete_mid_entry(struct mid_entry *mid)
@@ -556,6 +555,8 @@ olsr_print_mid_set(void)
  *registered with it and update its addresses.
  *
  *@param m the OLSR message received.
+ *@param in_if the incoming interface
+ *@param from_addr the sender address
  *@return 1 on success
  */
 
index b8690c0..caa46eb 100644 (file)
@@ -133,7 +133,7 @@ olsr_set_mpr_sel_timer(struct mpr_selector *mpr_sel, olsr_reltime rel_timer)
 /**
  *Add a MPR selector to the MPR selector set
  *
- *@param add address of the MPR selector
+ *@param addr address of the MPR selector
  *@param vtime validity time for the new entry
  *
  *@return a pointer to the new entry
index 0ac4b8c..f7c4aae 100644 (file)
@@ -99,7 +99,7 @@ olsr_del_nbr2_list(struct neighbor_2_list_entry *nbr2_list)
  * Delete a two hop neighbor from a neighbors two hop neighbor list.
  *
  * @param neighbor the neighbor to delete the two hop neighbor from.
- * @param address the IP address of the two hop neighbor to delete.
+ * @param neigh2 the IP address of the two hop neighbor to delete.
  *
  * @return positive if entry deleted
  */
@@ -168,9 +168,9 @@ olsr_update_neighbor_main_addr(struct neighbor_entry *entry, const union olsr_ip
  *
  *Remember: Deleting a neighbor entry results
  *the deletion of its 2 hop neighbors list!!!
- *@param neighbor the neighbor entry to delete
+ *@param neighbor_addr the neighbor entry to delete
  *
- *@return nada
+ *@return always 1
  */
 
 int
index febfa0a..ce2c9a3 100644 (file)
@@ -67,7 +67,7 @@ void net_os_set_global_ifoptions(void);
 int net_os_set_ifoptions(const char *if_name, struct interface *iface);
 int net_os_restore_ifoptions(void);
 
-int gethemusocket(struct sockaddr_in *);
+int gethemusocket(struct sockaddr_in *pin);
 
 int getsocket(int, struct interface *);
 
index 9876fb5..10b4ee3 100644 (file)
@@ -304,7 +304,8 @@ olsr_init_tables(void)
  *it if necessary.
  *
  *@param m the OLSR message to be forwarded
- *@param neighbour we received message from
+ *@param in_if the incoming interface
+ *@param from_addr neighbour we received message from
  *
  *@returns positive if forwarded
  */
@@ -549,6 +550,7 @@ olsr_status_to_string(uint8_t status)
  *that requires the daemon to terminate
  *
  *@param msg the message to write to the syslog and possibly stdout
+ *@param val the exit code
  */
 
 void
@@ -569,7 +571,7 @@ olsr_exit(const char *msg, int val)
  * Wrapper for malloc(3) that does error-checking
  *
  * @param size the number of bytes to allocalte
- * @param caller a string identifying the caller for
+ * @param id a string identifying the caller for
  * use in error messaging
  *
  * @return a void pointer to the memory allocated
index 1b6236d..6132d74 100644 (file)
@@ -254,10 +254,10 @@ olsr_packetparser_remove_function(packetparser_function * function)
  *Process a newly received OLSR packet. Checks the type
  *and to the neccessary convertions and call the
  *corresponding functions to handle the information.
- *@param from the sockaddr struct describing the sender
  *@param olsr the olsr struct containing the message
  *@param size the size of the message
- *@return nada
+ *@param in_if the incoming interface
+ *@param from_addr the sockaddr struct describing the sender
  */
 
 void
@@ -413,7 +413,8 @@ parse_packet(struct olsr *olsr, int size, struct interface *in_if, union olsr_ip
  *and passes the packet on to parse_packet().
  *
  *@param fd the filedescriptor that data should be read from.
- *@return nada
+ *@param data unused
+ *@param flags unused
  */
 void
 olsr_input(int fd, void *data __attribute__ ((unused)), unsigned int flags __attribute__ ((unused)))
@@ -508,7 +509,8 @@ olsr_input(int fd, void *data __attribute__ ((unused)), unsigned int flags __att
  *and passes the packet on to parse_packet().
  *
  *@param fd the filedescriptor that data should be read from.
- *@return nada
+ *@param data unused
+ *@param flags unused
  */
 void
 olsr_input_hostemu(int fd, void *data __attribute__ ((unused)), unsigned int flags __attribute__ ((unused)))
index 0e5ed0a..9b06117 100644 (file)
@@ -81,6 +81,7 @@ olsr_load_plugins(void)
  *the required information
  *
  *@param libname the name of the library(file)
+ *@param params plugin parameters
  *
  *@return negative on error
  */
index 72ded5a..780efab 100644 (file)
@@ -246,7 +246,7 @@ process_message_neighbors(struct neighbor_entry *neighbor, const struct hello_me
  *
  *@param neighbor the 1-hop neighbor
  *@param two_hop_neighbor the 2-hop neighbor
- *@return nada
+ *@param vtime the validity time
  */
 static void
 linking_this_2_entries(struct neighbor_entry *neighbor, struct neighbor_2_entry *two_hop_neighbor, olsr_reltime vtime)
@@ -285,7 +285,7 @@ linking_this_2_entries(struct neighbor_entry *neighbor, struct neighbor_2_entry
  * Check if a hello message states this node as a MPR.
  *
  * @param message the message to check
- * @param n_link the buffer to put the link status in
+ * @param in_if the incoming interface
  *
  *@return 1 if we are selected as MPR 0 if not
  */
index a3d01c0..90bd818 100644 (file)
@@ -517,6 +517,7 @@ olsr_rt_best(struct rt_entry *rt)
  *@param dst the destination
  *@param plen the prefix length
  *@param originator the originating router
+ *@param origin the origin of the route
  *
  *@return the new rt_path struct
  */
index d64a145..6b89732 100644 (file)
@@ -168,7 +168,10 @@ olsr_isTimedOut(uint32_t s)
  * in listen_loop
  *
  *@param fd the socket
- *@param pf the processing function
+ *@param pf_pr the processing function
+ *@param pf_imm the (immediate) processing function
+ *@param data the data pointer for the processing function
+ *@param flags the flags for the processing function
  */
 void
 add_olsr_socket(int fd, socket_handler_func pf_pr, socket_handler_func pf_imm, void *data, unsigned int flags)
@@ -200,7 +203,8 @@ add_olsr_socket(int fd, socket_handler_func pf_pr, socket_handler_func pf_imm, v
  * in listen_loop
  *
  *@param fd the socket
- *@param pf the processing function
+ *@param pf_pr the processing function
+ *@param pf_imm the (immediate) processing function
  */
 int
 remove_olsr_socket(int fd, socket_handler_func pf_pr, socket_handler_func pf_imm)
@@ -502,9 +506,9 @@ olsr_scheduler(void)
 /**
  * Decrement a relative timer by a random number range.
  *
- * @param the relative timer expressed in units of milliseconds.
- * @param the jitter in percent
- * @param cached result of random() at system init.
+ * @param rel_time the relative timer expressed in units of milliseconds.
+ * @param jitter_pct the jitter in percent
+ * @param random_val cached result of random() at system init.
  * @return the absolute timer in system clock tick units
  */
 static uint32_t
@@ -741,7 +745,7 @@ olsr_wallclock_string(void)
  * May be called upto 4 times in a single printf() statement.
  * Displays millisecond resolution.
  *
- * @param absolute time expressed in clockticks
+ * @param clk absolute time expressed in clockticks
  * @return buffer to a formatted system time string.
  */
 const char *
@@ -761,10 +765,12 @@ olsr_clock_string(uint32_t clk)
 /**
  * Start a new timer.
  *
- * @param relative time expressed in milliseconds
- * @param jitter expressed in percent
- * @param timer callback function
- * @param context for the callback function
+ * @param rel_time relative time expressed in milliseconds
+ * @param jitter_pct jitter expressed in percent
+ * @param periodical true for a repeating timer, false for a one-shot timer
+ * @param cb_func timer callback function
+ * @param context context for the callback function
+ * @param ci timer cookie
  * @return a pointer to the created entry
  */
 struct timer_entry *
@@ -815,8 +821,7 @@ olsr_start_timer(unsigned int rel_time,
 /**
  * Delete a timer.
  *
- * @param the timer_entry that shall be removed
- * @return nada
+ * @param timer the timer_entry that shall be removed
  */
 void
 olsr_stop_timer(struct timer_entry *timer)
@@ -845,10 +850,10 @@ olsr_stop_timer(struct timer_entry *timer)
 /**
  * Change a timer_entry.
  *
- * @param timer_entry to be changed.
- * @param new relative time expressed in units of milliseconds.
- * @param new jitter expressed in percent.
- * @return nada
+ * @param timer timer_entry to be changed.
+ * @param rel_time new relative time expressed in units of milliseconds.
+ * @param jitter_pct new jitter expressed in percent.
+ * @param periodical true for a repeating timer, false for a one-shot timer
  */
 void
 olsr_change_timer(struct timer_entry *timer, unsigned int rel_time, uint8_t jitter_pct, bool periodical)
index 9c44323..e1480d6 100644 (file)
@@ -128,7 +128,7 @@ olsr_seq_inrange_high(int beg, int end, uint16_t seq)
 /**
  * Add a new tc_entry to the tc tree
  *
- * @param (last)adr address of the entry
+ * @param adr (last)adr address of the entry
  * @return a pointer to the created entry
  */
 static struct tc_entry *
@@ -272,8 +272,7 @@ olsr_unlock_tc_entry(struct tc_entry *tc)
 /**
  * Delete a TC entry.
  *
- * @param entry the TC entry to delete
- *
+ * @param tc the TC entry to delete
  */
 void
 olsr_delete_tc_entry(struct tc_entry *tc)
@@ -424,7 +423,9 @@ olsr_calc_tc_edge_entry_etx(struct tc_edge_entry *tc_edge)
 /**
  * Add a new tc_edge_entry to the tc_edge_tree
  *
- * @param (last)adr address of the entry
+ * @param tc the tc entry
+ * @param addr (last)adr address of the entry
+ * @param ansn ansn of this edge
  * @return a pointer to the created entry
  */
 struct tc_edge_entry *
@@ -497,7 +498,6 @@ olsr_add_tc_edge_entry(struct tc_entry *tc, union olsr_ip_addr *addr, uint16_t a
 /**
  * Delete a TC edge entry.
  *
- * @param tc the TC entry
  * @param tc_edge the TC edge entry
  */
 void
@@ -554,6 +554,8 @@ olsr_delete_outdated_tc_edges(struct tc_entry *tc)
  *
  * @param tc the entry to delete edges from
  * @param ansn the advertised neighbor set sequence number
+ * @param lower_border the lower border
+ * @param upper_border the upper border
  * @return 1 if any destinations were deleted 0 if not
  */
 static int
@@ -596,8 +598,10 @@ olsr_delete_revoked_tc_edges(struct tc_entry *tc, uint16_t ansn, union olsr_ip_a
  * Creates new edge-entries if not registered.
  * Bases update on a received TC message
  *
- * @param entry the TC entry to check
- * @pkt the TC edge entry in the packet
+ * @param tc the TC entry to check
+ * @param ansn the ansn of the edge
+ * @param curr pointer to the packet
+ * @param neighbor the neighbor of the edge
  * @return 1 if entries are added 0 if not
  */
 static int
@@ -665,8 +669,8 @@ olsr_tc_update_edge(struct tc_entry *tc, uint16_t ansn, const unsigned char **cu
 /**
  * Lookup an edge hanging off a TC entry.
  *
- * @param entry the entry to check
- * @param dst_addr the destination address to check for
+ * @param tc the entry to check
+ * @param edge_addr the destination address to check for
  * @return a pointer to the tc_edge found - or NULL
  */
 struct tc_edge_entry *
index 19a8da1..7da6810 100644 (file)
@@ -68,7 +68,7 @@ olsr_init_two_hop_table(void)
  *
  *@param two_hop_entry the two hop neighbor to remove the
  *one hop neighbor from
- *@param address the address of the one hop neighbor to remove
+ *@param neigh address the address of the one hop neighbor to remove
  *
  *@return nada
  */