Revision 8e433d6a

View differences:

conf/cf-lex.l
575 575
/**
576 576
 * cf_lex_init - initialize the lexer
577 577
 * @is_cli: true if we're going to parse CLI command, false for configuration
578
 * @c: configuration structure
578 579
 *
579 580
 * cf_lex_init() initializes the lexical analyzer and prepares it for
580 581
 * parsing of a new input.
lib/Doc
1 1
H Library functions
2
S ip.c ipv4.c ipv6.c
2
S ip.c
3 3
S lists.c
4 4
S checksum.c bitops.c patmatch.c printf.c xmalloc.c tbf.c
5 5
D resource.sgml
nest/neighbor.c
339 339

  
340 340
/**
341 341
 * neigh_ifa_update: notify neighbor cache about interface address add or remove event
342
 * @ifa: interface address in question
342
 * @a: interface address in question
343 343
 *
344 344
 * Tell the neighbor cache that an address was added or removed.
345 345
 *
nest/proto-hooks.c
148 148
 * get_attr - get attribute information
149 149
 * @a: an extended attribute
150 150
 * @buf: buffer to be filled with attribute information
151
 * @buflen: a length of the @buf parameter
151 152
 *
152 153
 * The get_attr() hook is called by the core to obtain a user friendly
153 154
 * representation of an extended route attribute. It can either leave
nest/proto.c
718 718

  
719 719
/**
720 720
 * graceful_restart_done - finalize graceful restart
721
 * @t: unused
721 722
 *
722 723
 * When there are no locks on graceful restart, the functions finalizes the
723 724
 * graceful restart recovery. Protocols postponing route export until the end of
nest/rt-attr.c
405 405
 * for first occurrences of attributes with ID in specified interval from @id to
406 406
 * (@id + @max - 1), returning pointers to found &eattr structures, storing its
407 407
 * walk state in @s for subsequent calls.
408

  
408
 *
409 409
 * The function ea_walk() is supposed to be called in a loop, with initially
410 410
 * zeroed walk state structure @s with filled the initial extended attribute
411 411
 * list, returning one found attribute in each call or %NULL when no other
nest/rt-table.c
717 717
 * @net: network in question
718 718
 * @new: the new route to be announced
719 719
 * @old: the previous route for the same network
720
 * @new_best: the new best route for the same network
721
 * @old_best: the previous best route for the same network
722
 * @before_old: The previous route before @old for the same network.
723
 * 		If @before_old is NULL @old was the first.
720 724
 *
721 725
 * This function gets a routing table update and announces it
722 726
 * to all protocols that acccepts given type of route announcement
723 727
 * and are connected to the same table by their announcement hooks.
724 728
 *
725
 * Route announcement of type RA_OPTIMAL si generated when optimal
729
 * Route announcement of type %RA_OPTIMAL si generated when optimal
726 730
 * route (in routing table @tab) changes. In that case @old stores the
727 731
 * old optimal route.
728 732
 *
729
 * Route announcement of type RA_ANY si generated when any route (in
733
 * Route announcement of type %RA_ANY si generated when any route (in
730 734
 * routing table @tab) changes In that case @old stores the old route
731 735
 * from the same protocol.
732 736
 *
......
1616 1620

  
1617 1621
/**
1618 1622
 * rt_prune_table - prune a routing table
1623
 * @tab: a routing table for pruning
1619 1624
 *
1620 1625
 * This function scans the routing table @tab and removes routes belonging to
1621 1626
 * flushing protocols, discarded routes and also stale network entries, in a
proto/babel/Doc
1 1
S babel.c
2
S packet.c
2
S packets.c
proto/ospf/dbdes.c
192 192

  
193 193
/**
194 194
 * ospf_send_dbdes - transmit database description packet
195
 * @p: OSPF protocol instance
195 196
 * @n: neighbor
196 197
 *
197 198
 * Sending of a database description packet is described in 10.8 of RFC 2328.
proto/ospf/lsalib.c
554 554
/**
555 555
 * lsa_validate - check whether given LSA is valid
556 556
 * @lsa: LSA header
557
 * @lsa_type: one of %LSA_T_xxx
558
 * @ospf2: %true means OSPF version 2, %false means OSPF version 3
557 559
 * @body: pointer to LSA body
558 560
 *
559 561
 * Checks internal structure of given LSA body (minimal length,
560 562
 * consistency). Returns true if valid.
561 563
 */
562

  
563 564
int
564 565
lsa_validate(struct ospf_lsa_header *lsa, u32 lsa_type, int ospf2, void *body)
565 566
{
proto/ospf/packet.c
207 207
/**
208 208
 * ospf_rx_hook
209 209
 * @sk: socket we received the packet.
210
 * @size: size of the packet
210
 * @len: size of the packet
211 211
 *
212 212
 * This is the entry point for messages from neighbors. Many checks (like
213 213
 * authentication, checksums, size) are done before the packet is passed to
sysdep/unix/io.c
448 448
/**
449 449
 * tm_format_datetime - convert date and time to textual representation
450 450
 * @x: destination buffer of size %TM_DATETIME_BUFFER_SIZE
451
 * @fmt_spec: specification of resulting textual representation of the time
451 452
 * @t: time
452 453
 *
453 454
 * This function formats the given relative time value @t to a textual
sysdep/unix/log.c
89 89
/**
90 90
 * log_commit - commit a log message
91 91
 * @class: message class information (%L_DEBUG to %L_BUG, see |lib/birdlib.h|)
92
 * @buf: message to write
92 93
 *
93 94
 * This function writes a message prepared in the log buffer to the
94 95
 * log file (as specified in the configuration). The log buffer is

Also available in: Unified diff