]> git.ipfire.org Git - thirdparty/bird.git/commitdiff
Prog Doc: Complete several missing parameters
authorPavel Tvrdik <pawel.tvrdik@gmail.com>
Thu, 12 May 2016 13:49:44 +0000 (15:49 +0200)
committerPavel Tvrdik <pawel.tvrdik@gmail.com>
Thu, 12 May 2016 13:49:44 +0000 (15:49 +0200)
13 files changed:
conf/cf-lex.l
lib/Doc
nest/neighbor.c
nest/proto-hooks.c
nest/proto.c
nest/rt-attr.c
nest/rt-table.c
proto/babel/Doc
proto/ospf/dbdes.c
proto/ospf/lsalib.c
proto/ospf/packet.c
sysdep/unix/io.c
sysdep/unix/log.c

index 5a2a4d6b6e3e77bfb43530e52675d832b1cd0f30..727dc017064049b7f4d8113c4f836d1232aa476d 100644 (file)
@@ -575,6 +575,7 @@ cf_lex_init_kh(void)
 /**
  * cf_lex_init - initialize the lexer
  * @is_cli: true if we're going to parse CLI command, false for configuration
+ * @c: configuration structure
  *
  * cf_lex_init() initializes the lexical analyzer and prepares it for
  * parsing of a new input.
diff --git a/lib/Doc b/lib/Doc
index 8f5138215cd2b221bdec16f3d90a4b4cf892ebbb..8af1c6699363f2ac033a3795aeb3f6a63f0a798b 100644 (file)
--- a/lib/Doc
+++ b/lib/Doc
@@ -1,5 +1,5 @@
 H Library functions
-S ip.c ipv4.c ipv6.c
+S ip.c
 S lists.c
 S checksum.c bitops.c patmatch.c printf.c xmalloc.c tbf.c
 D resource.sgml
index 1685d67e3bbfa4b36ae549cbc8f7898db7fcc23d..d974fa519fc9181d8d311f87d94a13e18cd81e2c 100644 (file)
@@ -339,7 +339,7 @@ neigh_if_link(struct iface *i)
 
 /**
  * neigh_ifa_update: notify neighbor cache about interface address add or remove event
- * @ifa: interface address in question
+ * @a: interface address in question
  *
  * Tell the neighbor cache that an address was added or removed.
  *
index e80f87ea527517b4cab321a891eb2bbe1738ebb6..7395b45ec7224175eea296137b26fa53087dabf7 100644 (file)
@@ -148,6 +148,7 @@ void get_route_info(rte *e, byte *buf, ea_list *attrs)
  * get_attr - get attribute information
  * @a: an extended attribute
  * @buf: buffer to be filled with attribute information
+ * @buflen: a length of the @buf parameter
  *
  * The get_attr() hook is called by the core to obtain a user friendly
  * representation of an extended route attribute. It can either leave
index 3e97e9da11193fd5224ef03a82fc392d9c18d88d..1091b32102a555af97d94bc98a55864d525c9469 100644 (file)
@@ -718,6 +718,7 @@ graceful_restart_init(void)
 
 /**
  * graceful_restart_done - finalize graceful restart
+ * @t: unused
  *
  * When there are no locks on graceful restart, the functions finalizes the
  * graceful restart recovery. Protocols postponing route export until the end of
index 7fa05d6dc70a5397a931912b1b60ac2a31e8334f..f181b4527be618acc810725eccde4047529850a7 100644 (file)
@@ -405,7 +405,7 @@ ea_find(ea_list *e, unsigned id)
  * for first occurrences of attributes with ID in specified interval from @id to
  * (@id + @max - 1), returning pointers to found &eattr structures, storing its
  * walk state in @s for subsequent calls.
-
+ *
  * The function ea_walk() is supposed to be called in a loop, with initially
  * zeroed walk state structure @s with filled the initial extended attribute
  * list, returning one found attribute in each call or %NULL when no other
index 57c8b8e08a7d8cdc17335c7ce26be3c4eadc7858..c02e6dc94d7ea33e89652d620a93266909f2b055 100644 (file)
@@ -717,16 +717,20 @@ rt_notify_merged(struct announce_hook *ah, net *net, rte *new_changed, rte *old_
  * @net: network in question
  * @new: the new route to be announced
  * @old: the previous route for the same network
+ * @new_best: the new best route for the same network
+ * @old_best: the previous best route for the same network
+ * @before_old: The previous route before @old for the same network.
+ *             If @before_old is NULL @old was the first.
  *
  * This function gets a routing table update and announces it
  * to all protocols that acccepts given type of route announcement
  * and are connected to the same table by their announcement hooks.
  *
- * Route announcement of type RA_OPTIMAL si generated when optimal
+ * Route announcement of type %RA_OPTIMAL si generated when optimal
  * route (in routing table @tab) changes. In that case @old stores the
  * old optimal route.
  *
- * Route announcement of type RA_ANY si generated when any route (in
+ * Route announcement of type %RA_ANY si generated when any route (in
  * routing table @tab) changes In that case @old stores the old route
  * from the same protocol.
  *
@@ -1616,6 +1620,7 @@ again:
 
 /**
  * rt_prune_table - prune a routing table
+ * @tab: a routing table for pruning
  *
  * This function scans the routing table @tab and removes routes belonging to
  * flushing protocols, discarded routes and also stale network entries, in a
index 2480239e5298c2114f2616709b0fe9aa4d2f76e1..80026f915e72004934d7b48d0fb0c656b566ae7b 100644 (file)
@@ -1,2 +1,2 @@
 S babel.c
-S packet.c
+S packets.c
index 65bdb3ecc4c5834b9acf0b1d9a4d06c9fc803319..195b03adefdcad642beaccc4bae1fbff00594dd6 100644 (file)
@@ -192,6 +192,7 @@ ospf_do_send_dbdes(struct ospf_proto *p, struct ospf_neighbor *n)
 
 /**
  * ospf_send_dbdes - transmit database description packet
+ * @p: OSPF protocol instance
  * @n: neighbor
  *
  * Sending of a database description packet is described in 10.8 of RFC 2328.
index 66a3a23d0bfe8b35a2dc16edb1845e3badeb8d8d..1bbd13724490aae399bc1d44da8edd2baef005a8 100644 (file)
@@ -554,12 +554,13 @@ lsa_validate_prefix(struct ospf_lsa_header *lsa, struct ospf_lsa_prefix *body)
 /**
  * lsa_validate - check whether given LSA is valid
  * @lsa: LSA header
+ * @lsa_type: one of %LSA_T_xxx
+ * @ospf2: %true means OSPF version 2, %false means OSPF version 3
  * @body: pointer to LSA body
  *
  * Checks internal structure of given LSA body (minimal length,
  * consistency). Returns true if valid.
  */
-
 int
 lsa_validate(struct ospf_lsa_header *lsa, u32 lsa_type, int ospf2, void *body)
 {
index faa336645858d873d142f188c1cbe514f4dad926..04f0d47c3421b77d0bd3f89285b682d9ed5a6b2b 100644 (file)
@@ -207,7 +207,7 @@ drop:
 /**
  * ospf_rx_hook
  * @sk: socket we received the packet.
- * @size: size of the packet
+ * @len: size of the packet
  *
  * This is the entry point for messages from neighbors. Many checks (like
  * authentication, checksums, size) are done before the packet is passed to
index 82f6c69e02a3102575ab5d4078caa48be98381d6..486319ff50ebe0b57b2846fe9271c5211c37aaf8 100644 (file)
@@ -448,6 +448,7 @@ tm_format_reltime(char *x, struct tm *tm, bird_clock_t delta)
 /**
  * tm_format_datetime - convert date and time to textual representation
  * @x: destination buffer of size %TM_DATETIME_BUFFER_SIZE
+ * @fmt_spec: specification of resulting textual representation of the time
  * @t: time
  *
  * This function formats the given relative time value @t to a textual
index b90bbbd26339447c9c500ce7fe335b4e98dfafe9..6665d035bdcd545e0354f05bcc6c7a361d92294c 100644 (file)
@@ -89,6 +89,7 @@ static char *class_names[] = {
 /**
  * log_commit - commit a log message
  * @class: message class information (%L_DEBUG to %L_BUG, see |lib/birdlib.h|)
+ * @buf: message to write
  *
  * This function writes a message prepared in the log buffer to the
  * log file (as specified in the configuration). The log buffer is