doxygen fixes
authorHenning Rogge <henning.rogge@fkie.fraunhofer.de>
Wed, 22 Mar 2017 13:04:10 +0000 (14:04 +0100)
committerHenning Rogge <henning.rogge@fkie.fraunhofer.de>
Wed, 22 Mar 2017 13:04:10 +0000 (14:04 +0100)
71 files changed:
src-api/common/autobuf.h
src-api/common/avl.c
src-api/common/avl.h
src-api/common/bitstream.c
src-api/common/json.c
src-api/common/list.h
src-api/common/netaddr.c
src-api/common/netaddr.h
src-api/common/string.c
src-api/common/template.h
src-api/config/cfg.h
src-api/config/cfg_db.h
src-api/config/cfg_schema.c
src-api/core/oonf_logging.c
src-api/core/oonf_main.c
src-api/core/oonf_subsystem.c
src-plugins/generic/dlep/router/dlep_router_session.c
src-plugins/generic/layer2_config/layer2_config.c
src-plugins/generic/layer2info/layer2info.c
src-plugins/generic/link_config/link_config.c
src-plugins/generic/remotecontrol/remotecontrol.c
src-plugins/generic/systeminfo/systeminfo.c
src-plugins/nhdp/auto_ll4/auto_ll4.c
src-plugins/nhdp/constant_metric/constant_metric.c
src-plugins/nhdp/ff_dat_metric/ff_dat_metric.c
src-plugins/nhdp/hysteresis_olsrv1/hysteresis_olsrv1.c
src-plugins/nhdp/mpr/mpr.c
src-plugins/nhdp/mpr/neighbor-graph-flooding.c
src-plugins/nhdp/mpr/neighbor-graph-routing.c
src-plugins/nhdp/mpr/neighbor-graph.c
src-plugins/nhdp/mpr/selection-rfc7181.c
src-plugins/nhdp/nhdp/nhdp.c
src-plugins/nhdp/nhdp/nhdp_db.c
src-plugins/nhdp/nhdp/nhdp_hysteresis.c
src-plugins/nhdp/nhdp/nhdp_interfaces.c
src-plugins/nhdp/nhdp/nhdp_interfaces.h
src-plugins/nhdp/nhdp/nhdp_reader.c
src-plugins/nhdp/nhdp/nhdp_writer.c
src-plugins/nhdp/nhdpcheck/nhdpcheck.c
src-plugins/olsrv2/lan_import/lan_import.c
src-plugins/olsrv2/netjsoninfo/netjsoninfo.c
src-plugins/olsrv2/olsrv2/olsrv2.c
src-plugins/olsrv2/olsrv2/olsrv2_originator.c
src-plugins/olsrv2/olsrv2/olsrv2_reader.c
src-plugins/olsrv2/olsrv2/olsrv2_routing.c
src-plugins/olsrv2/olsrv2/olsrv2_writer.c
src-plugins/olsrv2/olsrv2info/olsrv2info.c
src-plugins/olsrv2/route_modifier/route_modifier.c
src-plugins/subsystems/oonf_clock.h
src-plugins/subsystems/oonf_http.c
src-plugins/subsystems/oonf_packet_socket.c
src-plugins/subsystems/oonf_rfc5444.c
src-plugins/subsystems/oonf_rfc5444.h
src-plugins/subsystems/oonf_socket.c
src-plugins/subsystems/oonf_stream_socket.c
src-plugins/subsystems/oonf_telnet.c
src-plugins/subsystems/oonf_timer.c
src-plugins/subsystems/oonf_timer.h
src-plugins/subsystems/oonf_viewer.c
src-plugins/subsystems/oonf_viewer.h
src-plugins/subsystems/os_linux/os_fd_linux.h
src-plugins/subsystems/os_linux/os_interface_linux.c
src-plugins/subsystems/os_linux/os_routing_linux.c
src-plugins/subsystems/os_linux/os_routing_linux.h
src-plugins/subsystems/os_linux/os_system_linux.c
src-plugins/subsystems/rfc5444/rfc5444_msg_generator.c
src-plugins/subsystems/rfc5444/rfc5444_pkt_generator.c
src-plugins/subsystems/rfc5444/rfc5444_print.c
src-plugins/subsystems/rfc5444/rfc5444_reader.c
src-plugins/subsystems/rfc5444/rfc5444_tlv_writer.c
src-plugins/subsystems/rfc5444/rfc5444_writer.c

index c654dd7..ce438df 100644 (file)
@@ -89,7 +89,7 @@ EXPORT void abuf_hexdump(struct autobuf *out,
 
 /**
  * Clears the content of an autobuf
- * @param autobuf
+ * @param autobuf autobuffer instance
  */
 static INLINE void
 abuf_clear(struct autobuf *autobuf) {
@@ -99,7 +99,7 @@ abuf_clear(struct autobuf *autobuf) {
 }
 
 /**
- * @param autobuf pointer to autobuf
+ * @param autobuf autobuffer instance
  * @return pointer to internal bufffer memory
  */
 static INLINE char *
@@ -108,7 +108,7 @@ abuf_getptr(struct autobuf *autobuf) {
 }
 
 /**
- * @param autobuf pointer to autobuf
+ * @param autobuf autobuffer instance
  * @return number of bytes stored in autobuf
  */
 static INLINE size_t
@@ -117,7 +117,7 @@ abuf_getlen(struct autobuf *autobuf) {
 }
 
 /**
- * @param autobuf pointer to autobuf
+ * @param autobuf autobuffer instance
  * @return number of bytes allocated in buffer
  */
 static INLINE size_t
@@ -126,9 +126,11 @@ abuf_getmax(struct autobuf *autobuf) {
 }
 
 /**
- *
- * @param autobuf
- * @param len
+ * set the length of the autobuffer, will truncate the length
+ * by the total amount of memory in the buffer. Normally used
+ * to shorten a buffer.
+ * @param autobuf autobuffer instance
+ * @param len new length of the autobuffer
  */
 static INLINE void
 abuf_setlen(struct autobuf * autobuf, size_t len) {
@@ -141,7 +143,7 @@ abuf_setlen(struct autobuf * autobuf, size_t len) {
 
 /**
  * Append a single byte to an autobuffer
- * @param autobuf
+ * @param autobuf autobuffer instance
  * @param c byte to append
  * @return -1 if an error happened, 0 otherwise
  */
@@ -152,7 +154,7 @@ abuf_append_uint8(struct autobuf *autobuf, const uint8_t c) {
 
 /**
  * Append a uint16 to an autobuffer
- * @param autobuf
+ * @param autobuf autobuffer instance
  * @param s uint16 to append
  * @return -1 if an error happened, 0 otherwise
  */
@@ -163,7 +165,7 @@ abuf_append_uint16(struct autobuf *autobuf, const uint16_t s) {
 
 /**
  * Append a uint32 to an autobuffer
- * @param autobuf
+ * @param autobuf autobuffer instance
  * @param l uint32 to append
  * @return -1 if an error happened, 0 otherwise
  */
@@ -173,7 +175,7 @@ abuf_append_uint32(struct autobuf *autobuf, const uint32_t l) {
 }
 
 /**
- * @param autobuf
+ * @param autobuf autobuffer instance
  * @return true if an autobuf function failed
  *  since the last cleanup of the stream
  */
index ca6b548..1cc73b1 100644 (file)
@@ -192,13 +192,13 @@ avl_find_greaterequal(const struct avl_tree *tree, const void *key) {
 }
 
 /**
- * Finds the end of linked list from the avl node
- * @param tree pointer to tree
- * @param node pointer
- * @return pointer to last node of the list
+ * Finds the last node with the same value than a reference node
+ * @param tree avl tree
+ * @param last reference node
+ * @return pointer to last node with the same value
  */
 struct avl_node*
-_avl_find_last(struct avl_tree *tree, struct avl_nodelast)
+_avl_find_last(struct avl_tree *tree, struct avl_node *last)
 {
   struct avl_node *next;
   while (!list_is_last(&tree->list_head, &last->list)) {
@@ -214,8 +214,8 @@ _avl_find_last(struct avl_tree *tree, struct avl_node* last)
 
 /**
  * Inserts an avl_node into a tree
- * @param tree pointer to tree
- * @param new pointer to node
+ * @param tree avl tree
+ * @param new node to be inserted into the tree
  * @return 0 if node was inserted successfully, -1 if it was not inserted
  *   because of a key collision
  */
index ab99f5b..8ef514c 100644 (file)
@@ -180,21 +180,6 @@ avl_is_node_added(const struct avl_node *node) {
   return list_is_node_added(&node->list);
 }
 
-/**
- * Legacy function for code that still use the old avl_delete
- * function instead of the new avl_remove one.
- *
- * Use avl_remove() !
- *
- * Remove a node from an avl tree
- * @param tree pointer to tree
- * @param node pointer to node
- */
-static INLINE void __attribute__((deprecated))
-avl_delete(struct avl_tree *tree, struct avl_node *node) {
-  avl_remove(tree, node);
-}
-
 /**
  * @param tree pointer to avl-tree
  * @param key pointer to key
index 1fa46b8..fc528c9 100644 (file)
@@ -177,7 +177,7 @@ bitstream_w_memcpy(struct bitstream_w *stream, const void *src, size_t bytes) {
  * @param stream bitstream
  * @param src input source
  * @param bits number of bits to copy
- * @return
+ * @return -1 if an error happened, 0 otherwise
  */
 int
 bitstream_w_write(struct bitstream_w *stream, uint64_t src, int32_t bits) {
index 960c0ba..79fd7f3 100644 (file)
@@ -222,7 +222,6 @@ _add_template(struct autobuf *out, bool brackets,
  * @param out pointer to output buffer
  * @param txt string to print
  * @param delimiter true if string must be enclosed in quotation marks
- * @return -1 if an error happened, 0 otherwise
  */
 static void
 _json_printvalue(struct autobuf *out, const char *txt, bool delimiter) {
index 3c62ce0..6ff67d7 100644 (file)
@@ -67,7 +67,7 @@ struct list_entity {
 
 /**
  * initialize a list-head
- * @param pointer to list-head
+ * @param head to list-head
  */
 static INLINE void
 list_init_head(struct list_entity *head) {
@@ -76,7 +76,7 @@ list_init_head(struct list_entity *head) {
 
 /**
  * initialize a list-node
- * @param pointer to list-node
+ * @param entity to list-node
  */
 static INLINE void
 list_init_node(struct list_entity *entity) {
@@ -129,7 +129,7 @@ list_add_before(struct list_entity *before, struct list_entity *new) {
 
 /**
  * adds a node after another node
- * @param before reference node in the list
+ * @param after reference node in the list
  * @param new node which will be added to the list
  */
 static INLINE void
index b5a5e8b..363baad 100644 (file)
@@ -1106,7 +1106,7 @@ _subnetmask_to_prefixlen(const char *src) {
  * Calculates if a binary address is part of a netaddr prefix.
  * It will assume that the length of the binary address and its
  * address family makes sense.
- * @param addr netaddr prefix
+ * @param subnet netaddr prefix
  * @param bin pointer to binary address
  * @return true if part of the prefix, false otherwise
  */
index 16f8206..5c6444d 100644 (file)
@@ -339,9 +339,9 @@ netaddr_cmp(const struct netaddr *a1, const struct netaddr *a2) {
 
 /**
  * Compares two sockets.
- * @param a1 address 1
- * @param a2 address 2
- * @return >0 if a1>a2, <0 if a1<a2, 0 otherwise
+ * @param s1 socket address port 1
+ * @param s2 socket address/port 2
+ * @return >0 if s1>s2, <0 if s1<s2, 0 otherwise
  */
 static INLINE int
 netaddr_socket_cmp(const union netaddr_socket *s1, const union netaddr_socket *s2) {
@@ -386,7 +386,7 @@ netaddr_get_prefix_length(const struct netaddr *n) {
 
 /**
  * @param n pointer to netaddr
- * @param prefix_length new prefix length
+ * @param prefix_len new prefix length
  */
 static INLINE void
 netaddr_set_prefix_length(struct netaddr *n, uint8_t prefix_len) {
index d50dc47..57faf2b 100644 (file)
@@ -56,8 +56,8 @@
  * @param size minimum size of block
  * @return rounded up block size of STRARRAY_BLOCKSIZE
  */
-static INLINE size_t STRARRAY_MEMSIZE(const size_t b) {
-  return (b + STRARRAY_BLOCKSIZE-1) & (~(STRARRAY_BLOCKSIZE - 1));
+static INLINE size_t STRARRAY_MEMSIZE(const size_t size) {
+  return (size + STRARRAY_BLOCKSIZE-1) & (~(STRARRAY_BLOCKSIZE - 1));
 }
 
 /**
index b98e1a4..6bd83b8 100644 (file)
@@ -125,10 +125,10 @@ EXPORT void abuf_add_template(struct autobuf *out,
 /**
  * Helper function to initialize a template with
  * a single abuf_template_data_entry array
- * @param storage
- * @param entry
- * @param entry_count
- * @param format
+ * @param storage storage for template data for output generation
+ * @param entry array of template data entries
+ * @param entry_count number of template data entries
+ * @param format format string for template generation
  */
 static INLINE void
 abuf_template_init(struct abuf_template_storage *storage,
index ebd8e7b..f8bbfae 100644 (file)
@@ -99,7 +99,7 @@ cfg_cmp_keys(const char *str1, const char *str2) {
 
 /**
  * Checks if a string value represents a positive boolean value
- * @param pointer to string
+ * @param value string representation of boolean
  * @return boolean value of the string representation
  */
 static INLINE bool
@@ -109,7 +109,7 @@ cfg_get_bool(const char *value) {
 
 /**
  * Checks if a string value represents a boolean value
- * @param pointer to string
+ * @param value string value that might contain a boolean text representation
  * @return true if string is a boolean, false otherwise
  */
 static INLINE bool
index 58fb1b6..169fe52 100644 (file)
@@ -328,7 +328,8 @@ cfg_db_find_sectiontype(const struct cfg_db *db, const char *section_type) {
 
 /**
  * Finds an unnamed section inside a section type
- * @param type pointer to section type
+ * @param db pointer to configuration database
+ * @param section_type type of section
  * @return pointer to section, NULL if not found
  */
 static INLINE struct cfg_named_section *
@@ -346,7 +347,7 @@ cfg_db_is_named_section(const struct cfg_named_section *named) {
 }
 
 /**
- * @param pointer to section type
+ * @param stype section type
  * @return pointer pointer to 'unnamed' named_section element,
  *   NULL no unnamed section.
  */
index f8feb0b..e15d49c 100644 (file)
@@ -69,11 +69,10 @@ static bool _validate_cfg_entry(
     struct cfg_named_section *named, struct cfg_entry *entry,
     const char *section_name, bool cleanup, struct autobuf *out);
 static bool _section_needs_default_named_one(struct cfg_section_type *type);
-static void _handle_named_section_change(struct cfg_schema_section *s_section,
-    struct cfg_db *pre_change, struct cfg_db *post_change,
-    const char *name, bool startup,
-    struct cfg_named_section *pre_defnamed,
-    struct cfg_named_section *post_defnamed);
+void _handle_named_section_change (struct cfg_schema_section* s_section, 
+    struct cfg_db* pre_change, struct cfg_db* post_change, const char* section_name, 
+    bool startup, struct cfg_named_section* pre_defnamed, 
+    struct cfg_named_section* post_defnamed);
 static int _handle_db_changes(struct cfg_db *pre_change,
     struct cfg_db *post_change, bool startup);
 
@@ -1051,7 +1050,6 @@ _handle_db_changes(struct cfg_db *pre_change, struct cfg_db *post_change, bool s
 
 /**
  * Validates on configuration entry.
- * @param schema_section pointer to schema section
  * @param db pointer to database
  * @param section pointer to database section type
  * @param named pointer to named section
@@ -1120,12 +1118,15 @@ _validate_cfg_entry(struct cfg_db *db, struct cfg_section_type *section,
  * @param s_section schema entry for section
  * @param pre_change pointer to database before changes
  * @param post_change pointer to database after changes
- * @param name
+ * @param section_name name of section, might be NULL for unnamed one
+ * @param startup true comparison against empty database at startup
+ * @param pre_defnamed named section with default name before change
+ * @param post_defnamed named section with default name after change
  */
 static void
 _handle_named_section_change(struct cfg_schema_section *s_section,
     struct cfg_db *pre_change, struct cfg_db *post_change,
-    const char *name, bool startup,
+    const char *section_name, bool startup,
     struct cfg_named_section *pre_defnamed,
     struct cfg_named_section *post_defnamed) {
   struct cfg_schema_entry *entry;
@@ -1135,7 +1136,7 @@ _handle_named_section_change(struct cfg_schema_section *s_section,
   if ((s_section->mode == CFG_SSMODE_NAMED
        || s_section->mode == CFG_SSMODE_NAMED_MANDATORY
        || s_section->mode == CFG_SSMODE_NAMED_WITH_DEFAULT)
-      && name == NULL) {
+      && section_name == NULL) {
     /*
      * ignore unnamed data entry for named sections, they are only
      * used for delivering defaults
@@ -1143,11 +1144,11 @@ _handle_named_section_change(struct cfg_schema_section *s_section,
     return;
   }
 
-  s_section->pre = cfg_db_find_namedsection(pre_change, s_section->type, name);
-  s_section->post = cfg_db_find_namedsection(post_change, s_section->type, name);
+  s_section->pre = cfg_db_find_namedsection(pre_change, s_section->type, section_name );
+  s_section->post = cfg_db_find_namedsection(post_change, s_section->type, section_name );
 
   if (s_section->mode == CFG_SSMODE_NAMED_WITH_DEFAULT
-      && strcasecmp(s_section->def_name, name) == 0) {
+      && strcasecmp(s_section->def_name, section_name ) == 0) {
     /* use the default named sections if necessary */
     if (s_section->pre == NULL && !startup) {
       s_section->pre = pre_defnamed;
@@ -1172,16 +1173,16 @@ _handle_named_section_change(struct cfg_schema_section *s_section,
 
     /* read values */
     entry->pre = cfg_db_get_entry_value(
-        pre_change, s_section->type, name, entry->key.entry);
+        pre_change, s_section->type, section_name, entry->key.entry);
     entry->post = cfg_db_get_entry_value(
-        post_change, s_section->type, name, entry->key.entry);
+        post_change, s_section->type, section_name, entry->key.entry);
 
     entry->delta_changed = strarray_cmp_c(entry->pre, entry->post);
     changed |= entry->delta_changed;
   }
 
   if (changed || startup) {
-    s_section->section_name = name;
+    s_section->section_name = section_name;
     s_section->cb_delta_handler();
   }
 }
index de8adc4..d1839c1 100644 (file)
@@ -175,7 +175,6 @@ oonf_log_cleanup(void)
  * Registers a custom logevent handler. Handler and bitmask_ptr have to
  * be initialized.
  * @param h pointer to log event handler struct
- * @return -1 if an out of memory error happened, 0 otherwise
  */
 void
 oonf_log_addhandler(struct oonf_log_handler_entry *h)
index 7c69dc1..fafbd30 100644 (file)
@@ -358,7 +358,7 @@ oonf_main_shall_stop_scheduler(void) {
 
 /**
  * Write process ID into file
- * @param filename
+ * @param filename name/path of pidfile
  * @return -1 if an error happened, 0 otherwise
  */
 static int
@@ -389,7 +389,7 @@ _write_pidfile(const char *filename) {
 
 /**
  * Handle incoming SIGINT signal
- * @param signo
+ * @param signo unused
  */
 static void
 quit_signal_handler(int signo __attribute__ ((unused))) {
@@ -398,7 +398,7 @@ quit_signal_handler(int signo __attribute__ ((unused))) {
 
 /**
  * Handle incoming SIGHUP signal
- * @param signo
+ * @param signo unused
  */
 static void
 hup_signal_handler(int signo __attribute__ ((unused))) {
@@ -407,6 +407,9 @@ hup_signal_handler(int signo __attribute__ ((unused))) {
 
 /**
  * Mainloop of olsrd
+ * @param argc argument counter
+ * @param argv argument vector
+ * @param appdata OONF appdata
  * @return exit code for olsrd
  */
 static int
@@ -501,8 +504,7 @@ parse_early_commandline(int argc, char **argv) {
  * Parse command line of olsrd
  * @param argc number of arguments
  * @param argv argument vector
- * @param def_config default configuration file, NULL if
- *   no default config file should be loaded
+ * @param appdata OONF appdata
  * @param reload_only true if only the command line arguments should
  *   be parsed that load a configuration (--set, --remove, --load,
  *   and --format), false for normal full parsing.
index fb57b59..1b32b04 100644 (file)
@@ -261,7 +261,6 @@ oonf_subsystem_hook(struct oonf_subsystem *plugin) {
  * prefix and/or postfix
  * @param pluginname buffer for plugin name
  * @param libname library name
- * @return pointer to buffer with plugin name, must be freed later
  */
 void
 oonf_subsystem_extract_name(
@@ -507,7 +506,7 @@ _unload_plugin(struct oonf_subsystem *plugin, bool cleanup) {
   OONF_INFO(LOG_PLUGINS, "Unloading plugin %s\n", plugin->name);
 
   /* remove first from tree */
-  avl_delete(&oonf_plugin_tree, &plugin->_node);
+  avl_remove(&oonf_plugin_tree, &plugin->_node);
 
   /* cleanup */
   if (plugin->_dlhandle) {
index 8cf50b5..5515645 100644 (file)
@@ -241,8 +241,8 @@ _cb_tcp_lost(struct oonf_stream_session *tcp_session) {
 
 /**
  * Receive tcp data via oonf_stream_socket
- * @param tcp_session
- * @return
+ * @param tcp_session tcp session to DLEP partner
+ * @return new state of TCP session
  */
 static enum oonf_stream_session_state
 _cb_tcp_receive_data(struct oonf_stream_session *tcp_session) {
@@ -279,7 +279,7 @@ _cb_send_buffer(struct dlep_session *session,
 
 /**
  * Callback triggered when session is terminated
- * @param session
+ * @param session dlep session
  */
 static void
 _cb_end_session(struct dlep_session *session) {
index 1034641..150327b 100644 (file)
@@ -333,11 +333,11 @@ _cb_reconfigure(struct oonf_timer_instance *timer) {
 
 /**
  * Configuration subsystem validator for linkdata
- * @param entry
- * @param section_name
- * @param value
- * @param out
- * @return
+ * @param entry configuration schema entry
+ * @param section_name section name the entry was set
+ * @param value value of the entry
+ * @param out output buffer for error messages
+ * @return -1 if validation failed, 0 otherwise
  */
 static int
 _cb_validate_l2netdata(const struct cfg_schema_entry *entry,
@@ -373,11 +373,11 @@ _cb_validate_l2netdata(const struct cfg_schema_entry *entry,
 
 /**
  * Configuration subsystem validator for linkdata
- * @param entry
- * @param section_name
- * @param value
- * @param out
- * @return
+ * @param entry configuration schema entry
+ * @param section_name section name the entry was set
+ * @param value value of the entry
+ * @param out output buffer for error messages
+ * @return -1 if validation failed, 0 otherwise
  */
 static int
 _cb_validate_l2defdata(const struct cfg_schema_entry *entry,
@@ -413,11 +413,11 @@ _cb_validate_l2defdata(const struct cfg_schema_entry *entry,
 
 /**
  * Configuration subsystem validator for linkdata
- * @param entry
- * @param section_name
- * @param value
- * @param out
- * @return
+ * @param entry configuration schema entry
+ * @param section_name section name the entry was set
+ * @param value value of the entry
+ * @param out output buffer for error messages
+ * @return -1 if validation failed, 0 otherwise
  */
 static int
 _cb_validate_l2neighdata(const struct cfg_schema_entry *entry,
index 71a4ecb..efb0801 100644 (file)
@@ -396,7 +396,6 @@ _initialize_if_values(struct oonf_layer2_net *net) {
 /**
  * Initialize the value buffers for an array of layer2 data objects
  * @param template viewer template
- * @param dst array of destination buffers
  * @param data array of data objects
  */
 static void
@@ -454,10 +453,7 @@ _initialize_neigh_values(struct oonf_layer2_neigh *neigh) {
 /**
  * Initialize the value buffers for an array of layer2 data objects
  * @param template viewer template
- * @param dst array of destination buffers
  * @param data array of data objects
- * @param meta array of metadata description of objects
- * @param count number of objects in each array
  */
 static void
 _initialize_neigh_data_values(struct oonf_viewer_template *template,
index d7d1bb7..85d5d38 100644 (file)
@@ -231,11 +231,11 @@ _cb_delayed_config(struct oonf_timer_instance *timer __attribute__((unused))) {
 
 /**
  * Configuration subsystem validator for linkdata
- * @param entry
- * @param section_name
- * @param value
- * @param out
- * @return
+ * @param entry configuration schema entry
+ * @param section_name name of the configuration section the entry was set
+ * @param value text value of the configuration entry
+ * @param out output buffer for error messages
+ * @return -1 if validation failed, 0 otherwise
  */
 static int
 _cb_validate_linkdata(const struct cfg_schema_entry *entry,
index f8ee78d..a624ff1 100644 (file)
@@ -291,7 +291,7 @@ _update_logfilter(struct oonf_telnet_data *data,
 
 /**
  * Log handler for telnet output
- * @param entry logging handler
+ * @param h logging handler
  * @param param logging parameter set
  */
 static void
@@ -308,7 +308,7 @@ _cb_print_log(struct oonf_log_handler_entry *h __attribute__((unused)),
 
 /**
  * Stop handler for continous logging output
- * @param telnet pointer ot telnet telnet
+ * @param session telnet session data
  */
 static void
 _stop_logging(struct oonf_telnet_data *session) {
@@ -468,7 +468,7 @@ _cb_handle_config(struct oonf_telnet_data *data) {
 
 /**
  * Handle interrupt from user console during route output
- * @param session
+ * @param data telnet session data
  */
 static void
 _cb_route_stophandler(struct oonf_telnet_data *data) {
@@ -480,7 +480,7 @@ _cb_route_stophandler(struct oonf_telnet_data *data) {
 
 /**
  * Handle end of incoming route data
- * @param rt pointer to os_route object
+ * @param rt OS route data
  * @param error error code, 0 if 0 error
  */
 static void
index 4753359..796f738 100644 (file)
@@ -414,8 +414,8 @@ _initialize_socket_values(struct oonf_viewer_template *template,
 
 /**
  * Initialize the value buffers for a logging source
- * @param template
- * @param source
+ * @param template viewer template
+ * @param source logging source
  */
 static void _initialize_logging_values(
     struct oonf_viewer_template *template, enum oonf_log_source source) {
index e052bd5..62b7dbb 100644 (file)
@@ -556,7 +556,8 @@ _cb_update_timer(struct oonf_timer_instance *ptr) {
 
 /**
  * Generate a new auto-configured address on an interface
- * @param nhdp_if pointer to NHDP interface
+ * @param auto_ll4 private auto_ll4 data structure
+ * @param ipv6_ll linklocal IPv6 address
  */
 static void
 _generate_default_address(struct _nhdp_if_autoll4 *auto_ll4, const struct netaddr *ipv6_ll) {
@@ -587,7 +588,7 @@ _generate_default_address(struct _nhdp_if_autoll4 *auto_ll4, const struct netadd
 /**
  * Get the current number of IPv4 addresses of an interface and
  * copy an IPv4 link-local address if set.
- * @param ifdata pointer to interface data
+ * @param os_if interface data
  * @param ll4_addr return buffer for link-local address
  * @param current_ll4 current link-local address, this will be returned
  *   if set, even if multiple ipv4 link-local addresses are present
index c8bbc7c..4cebdc4 100644 (file)
@@ -294,9 +294,9 @@ _cb_set_linkcost(struct oonf_timer_instance *ptr __attribute__((unused))) {
 /**
  * compare two linkcosts with each other by comparing
  * interface name and neighbor IP
- * @param ptr1
- * @param ptr2
- * @return
+ * @param ptr1 first linkcost data
+ * @param ptr2 second linkcost data
+ * @return -1/0/1 depending on comparision of both
  */
 static int
 _avlcmp_linkcost(const void *ptr1, const void *ptr2) {
@@ -315,11 +315,11 @@ _avlcmp_linkcost(const void *ptr1, const void *ptr2) {
 
 /**
  * Validate configuration parameter for a constant metric
- * @param entry
- * @param section_name
- * @param value
- * @param out
- * @return
+ * @param entry configuration schema entry
+ * @param section_name name of section the entry was set
+ * @param value value of the entry
+ * @param out output buffer for error messages
+ * @return -1 if validation failed, 0 otherwise
  */
 static int
 _cb_validate_link(const struct cfg_schema_entry *entry,
index d26c316..f4088cc 100644 (file)
@@ -920,9 +920,8 @@ _shall_process_packet(struct nhdp_interface *nhdpif, struct ff_dat_if_config *if
 /**
  * Callback to process all in RFC5444 packets for metric calculation. The
  * Callback ignores all unicast packets.
- * @param consumer
- * @param context
- * @return
+ * @param context RFC5444 context of the incoming packet
+ * @return RFC5444 API result
  */
 static enum rfc5444_result
 _cb_process_packet(struct rfc5444_reader_tlvblock_context *context) {
@@ -976,13 +975,6 @@ _cb_process_packet(struct rfc5444_reader_tlvblock_context *context) {
   lnk = laddr->link;
   ldata = oonf_class_get_extension(&_link_extenstion, lnk);
 
-  if (!ldata->buckets) {
-    OONF_WARN(LOG_FF_DAT, "No buckets for link to %s (%s)",
-        netaddr_to_string(&nbuf, &lnk->if_addr),
-        nhdp_interface_get_name(lnk->local_if));
-    return RFC5444_OKAY;
-  }
-
   if (!ldata->contains_data) {
     ldata->contains_data = true;
     ldata->activePtr = 0;
@@ -1077,17 +1069,8 @@ _int_link_to_string(struct nhdp_metric_str *buf, struct nhdp_link *lnk) {
   int64_t received = 0, total = 0;
   size_t i;
 
-  struct netaddr_str nbuf;
-
   ldata = oonf_class_get_extension(&_link_extenstion, lnk);
 
-  if (!ldata->buckets) {
-    OONF_WARN(LOG_FF_DAT, "No buckets for link to %s (%s)",
-        netaddr_to_string(&nbuf, &lnk->if_addr),
-        nhdp_interface_get_name(lnk->local_if));
-    return RFC5444_OKAY;
-  }
-
   for (i=0; i<ARRAYSIZE(ldata->buckets); i++) {
     received += ldata->buckets[i].received;
     total += ldata->buckets[i].total;
index e2106f6..414397b 100644 (file)
@@ -287,9 +287,7 @@ _cb_link_removed(void *ptr) {
  * Callback for hysteresis handler which is triggered to
  * update the hysteresis when a HELLO is received.
  * @param lnk nhdp link
- * @param context RFC5444 message context
- * @param vtime validity time
- * @param itime itime time, 0 if not set
+ * @param context RFC5444 tlvblock reader context
  */
 static void
 _cb_update_hysteresis(struct nhdp_link *lnk,
index fa35d28..3860c44 100644 (file)
@@ -136,7 +136,7 @@ _cleanup(void) {
 
 /**
  * Updates the current routing MPR selection in the NHDP database
- * @param current_mpr_data
+ * @param graph MPR neighbor graph instance
  */
 static void
 _update_nhdp_routing(struct neighbor_graph *graph) {
@@ -156,7 +156,7 @@ _update_nhdp_routing(struct neighbor_graph *graph) {
 
 /**
  * Updates the current flooding MPR selection in the NHDP database
- * @param current_mpr_data
+ * @param graph MPR neighbor graph instance
  */
 static void
 _update_nhdp_flooding(struct neighbor_graph *graph) {
@@ -175,7 +175,6 @@ _update_nhdp_flooding(struct neighbor_graph *graph) {
 
 /**
  * Updates the current flooding MPR selection in the NHDP database
- * @param current_mpr_data
  */
 static void
 _clear_nhdp_flooding(void) {
@@ -188,6 +187,9 @@ _clear_nhdp_flooding(void) {
   }
 }
 
+/**
+ * Update the flooding MPR settings 
+ */
 static void
 _update_flooding_mpr(void) {
   struct mpr_flooding_data flooding_data;
@@ -218,6 +220,9 @@ _update_flooding_mpr(void) {
 
 }
 
+/**
+ * Update the routing MPR settings for all domains
+ */
 static void
 _update_routing_mpr(void) {
   struct neighbor_graph routing_graph;
@@ -263,8 +268,8 @@ _cb_update_mpr(void) {
 
 /**
  * Validate the MPR set according to section 18.3 (draft 19)
- * @param current_mpr_data
- * @return 
+ * @param domain NHDP domaine
+ * @param graph MPR neighbor graph instance
  */
 static void
 _validate_mpr_set(const struct nhdp_domain *domain, struct neighbor_graph *graph)
index c6b9fb6..a0a7cef 100644 (file)
@@ -92,9 +92,10 @@ static struct neighbor_graph_interface _api_interface = {
 
 /**
  * Check if a given tuple is "reachable" according to section 18.4
- * @param mpr_data
- * @param link
- * @return 
+ * @param domain NHDP domain
+ * @param current_interface NHDP interface
+ * @param lnk NHDP link
+ * @return true if reachable, false otherwise
  */
 static bool
 _is_reachable_link_tuple(const struct nhdp_domain *domain,
@@ -112,9 +113,10 @@ _is_reachable_link_tuple(const struct nhdp_domain *domain,
 
 /**
  * Check if a link tuple is "allowed" according to section 18.4
- * @param mpr_data
- * @param link
- * @return 
+ * @param domain NHDP domain
+ * @param current_interface NHDP interface
+ * @param lnk NHDP link
+ * @return true if link tuple is allowed, false otherwise
  */
 static bool
 _is_allowed_link_tuple(const struct nhdp_domain *domain,
@@ -202,9 +204,10 @@ _calculate_d_x_y(const struct nhdp_domain *domain,
 
 /**
  * Calculate d1(x) according to section 18.2 (draft 19)
- * @param mpr_data
- * @param addr
- * @return 
+ * @param domain NHDP domain
+ * @param graph neighbor graph instance
+ * @param addr node address
+ * @return distance of node
  */
 uint32_t
 _calculate_d1_x_of_n2_addr(const struct nhdp_domain *domain,
@@ -230,7 +233,8 @@ _calculate_d1_x_of_n2_addr(const struct nhdp_domain *domain,
 
 /**
  * Calculate N1
- * @param interf
+ * @param domain NHDP domain
+ * @param data flooding data
  */
 static void
 _calculate_n1(const struct nhdp_domain *domain, struct mpr_flooding_data *data) {
@@ -259,8 +263,8 @@ _calculate_n1(const struct nhdp_domain *domain, struct mpr_flooding_data *data)
  * Note that N1 is generated per-interface, so we don't need to deal with 
  * multiple links to the same N1 member.
  * 
- * @param set_n1 N1 Set
- * @return 
+ * @param domain NHDP domain
+ * @param data flooding data
  */
 static void
 _calculate_n2(const struct nhdp_domain *domain, struct mpr_flooding_data *data) {
@@ -282,9 +286,9 @@ _calculate_n2(const struct nhdp_domain *domain, struct mpr_flooding_data *data)
 
 /**
  * Returns the flooding/routing willingness of an N1 neighbor
- * @param not used
- * @param node
- * @return 
+ * @param domain NHDP domain
+ * @param node NHDP node
+ * @return flooding willingness of NHDP node
  */
 static uint32_t
 _get_willingness_n1(const struct nhdp_domain *domain __attribute__((unused)),
index 6cc6a85..62da2e2 100644 (file)
@@ -89,9 +89,8 @@ static struct neighbor_graph_interface _rt_api_interface = {
 
 /**
  * Check if a given tuple is "reachable" according to section 18.4
- * @param mpr_data
- * @param link
- * @return 
+ * @param neigh NHDP neighbor
+ * @return true if reachable, false otherwise
  */
 static bool
 _is_reachable_neighbor_tuple(struct nhdp_neighbor *neigh) {
@@ -103,10 +102,10 @@ _is_reachable_neighbor_tuple(struct nhdp_neighbor *neigh) {
 }
 
 /**
- * Check if a link tuple is "allowed" according to section 18.4
- * @param mpr_data
- * @param link
- * @return 
+ * Check if a neighbor tuple is "allowed" according to section 18.4
+ * @param domain NHDP domain
+ * @param neigh NHDP neighbor
+ * @return true if allowed, false otherwise
  */
 static bool
 _is_allowed_neighbor_tuple(const struct nhdp_domain *domain __attribute__((unused)),
@@ -138,9 +137,9 @@ _is_allowed_2hop_tuple(const struct nhdp_domain *domain, struct nhdp_l2hop *two_
 
 /**
  * Calculate d1(x) according to section 18.2 (draft 19)
- * @param mpr_data
- * @param x
- * @return 
+ * @param domain NHDP domain
+ * @param x node x
+ * @return metric distance
  */
 static uint32_t
 _calculate_d1_x(const struct nhdp_domain *domain, struct n1_node *x) {
@@ -152,9 +151,10 @@ _calculate_d1_x(const struct nhdp_domain *domain, struct n1_node *x) {
 
 /**
  * Calculate d2(x,y) according to section 18.2 (draft 19)
- * @param x
- * @param y
- * @return 
+ * @param domain NHDP domain
+ * @param x node x
+ * @param y node y
+ * @return metric distance
  */
 static uint32_t
 _calculate_d2_x_y(const struct nhdp_domain *domain, struct n1_node *x, struct addr_node *y) {
@@ -213,8 +213,10 @@ _calculate_d_x_y(const struct nhdp_domain *domain,
 
 /**
  * Calculate d1(y) according to section 18.2 (draft 19)
- * @param mpr_data
- * @return 
+ * @param domain NHDP domain
+ * @param graph neighbor graph instance
+ * @param y node y
+ * @return metric distance
  */
 static uint32_t
 _calculate_d1_of_y(const struct nhdp_domain *domain,
@@ -237,9 +239,10 @@ _calculate_d1_of_y(const struct nhdp_domain *domain,
 
 /**
  * Calculate d1(x) according to section 18.2 (draft 19)
- * @param mpr_data
- * @param addr
- * @return 
+ * @param domain NHDP domain
+ * @param graph neighbor graph instance
+ * @param addr node address
+ * @return metric distance
  */
 static uint32_t
 _calculate_d1_x_of_n2_addr(const struct nhdp_domain *domain,
@@ -253,7 +256,8 @@ _calculate_d1_x_of_n2_addr(const struct nhdp_domain *domain,
 
 /**
  * Calculate N1
- * @param interf
+ * @param domain NHDP domain
+ * @param graph neighbor graph instance
  */
 static void
 _calculate_n1(const struct nhdp_domain *domain, struct neighbor_graph *graph) {
@@ -322,9 +326,9 @@ _calculate_n2(const struct nhdp_domain *domain, struct neighbor_graph *graph) {
 
 /**
  * Returns the flooding/routing willingness of an N1 neighbor
- * @param not used
- * @param node
- * @return 
+ * @param domain NHDP domain
+ * @param node neighbor node
+ * @return willingness
  */
 static uint32_t
 _get_willingness_n1(const struct nhdp_domain *domain, struct n1_node *node) {
index 35a9710..ebdaaad 100644 (file)
@@ -101,7 +101,8 @@ mpr_add_addr_node_to_set(struct avl_tree *set, const struct netaddr addr, uint32
 
 /**
  * Initialize the MPR data set
- * @param current_mpr_data
+ * @param graph neighbor graph instance
+ * @param methods callback for handling graph
  */
 void
 mpr_init_neighbor_graph(struct neighbor_graph *graph, struct neighbor_graph_interface *methods) {
@@ -115,7 +116,7 @@ mpr_init_neighbor_graph(struct neighbor_graph *graph, struct neighbor_graph_inte
 
 /**
  * Clear a set of addresses
- * @param set
+ * @param set AVL set to clear
  */
 void
 mpr_clear_addr_set(struct avl_tree *set) {
@@ -129,7 +130,7 @@ mpr_clear_addr_set(struct avl_tree *set) {
 
 /**
  * Clear set of N1 nodes
- * @param set
+ * @param set AVL set to clear
  */
 void
 mpr_clear_n1_set(struct avl_tree *set) {
@@ -143,7 +144,7 @@ mpr_clear_n1_set(struct avl_tree *set) {
 
 /**
  * Clear the MPR data set
- * @param current_mpr_data
+ * @param graph neighbor graph instance
  */
 void
 mpr_clear_neighbor_graph(struct neighbor_graph *graph) {
@@ -160,9 +161,9 @@ mpr_clear_neighbor_graph(struct neighbor_graph *graph) {
 
 /**
  * Check if a node was selected as an MPR
- * @param set_mpr
- * @param addr
- * @return 
+ * @param graph neighbor graph instance
+ * @param addr network address to check
+ * @return true if mpr, false otherwise
  */
 bool
 mpr_is_mpr(struct neighbor_graph *graph, struct netaddr *addr) {
@@ -221,7 +222,7 @@ mpr_calculate_minimal_d_z_y(const struct nhdp_domain *domain,
 
 /**
  * Print a set of addresses
- * @param set
+ * @param set AVL set to print
  */
 void
 mpr_print_addr_set(struct avl_tree *set) {
@@ -253,7 +254,7 @@ mpr_print_n1_set(struct avl_tree *set) {
 
 /**
  * Print the MPR data sets 
- * @param current_mpr_data
+ * @param graph neighbor graph instance
  */
 void
 mpr_print_sets(struct neighbor_graph *graph) {
@@ -272,8 +273,11 @@ mpr_print_sets(struct neighbor_graph *graph) {
 
 /**
  * Calculate d(y,S) according to section 18.2 (draft 19)
- * @param mpr_data
- * @return 
+ * @param domain NHDP domain
+ * @param graph neighbor graph instance
+ * @param y graph node Y
+ * @param subset_s subset of graph
+ * @return metric cost
  */
 uint32_t
 mpr_calculate_d_of_y_s(const struct nhdp_domain *domain, struct neighbor_graph *graph, struct addr_node *y,
index 2dc9c5d..f1bbdc6 100644 (file)
@@ -77,9 +77,8 @@ static unsigned int _calculate_r(const struct nhdp_domain *domain,
  * direct link that has a lower metric cost than the two-hop path (so
  * it should  be covered by an MPR node).
  * 
- * @param set_n1 N1 Set
- * @param set_n2 N2 Set
- * @return 
+ * @param domain NHDP domain
+ * @param graph neighbor graph instance
  */
 static void
 _calculate_n(const struct nhdp_domain *domain, struct neighbor_graph *graph) {
@@ -125,8 +124,10 @@ _calculate_n(const struct nhdp_domain *domain, struct neighbor_graph *graph) {
  * z in N1, and no such minimal values have z in M.
  * 
  * TODO Clean up code
- * 
- * @return 
+ * @param domain NHDP domain
+ * @param graph neighbor graph instance
+ * @param x_node node X
+ * @return see RFC
  */
 static unsigned int
 _calculate_r(const struct nhdp_domain *domain, struct neighbor_graph *graph,
@@ -194,7 +195,8 @@ _calculate_r(const struct nhdp_domain *domain, struct neighbor_graph *graph,
 
 /**
  * Add all elements x in N1 that have W(x) = WILL_ALWAYS to M.
- * @param current_mpr_data
+ * @param domain NHDP domain
+ * @param graph neighbor graph instance
  */
 static void
 _process_will_always(const struct nhdp_domain *domain, struct neighbor_graph *graph) {
@@ -220,7 +222,8 @@ _process_will_always(const struct nhdp_domain *domain, struct neighbor_graph *gr
 /**
  * For each element y in N for which there is only one element
  * x in N1 such that d2(x,y) is defined, add that element x to M.
- * @param current_mpr_data
+ * @param domain NHDP domain
+ * @param graph neighbor graph instance
  */
 static void
 _process_unique_mprs(const struct nhdp_domain *domain, struct neighbor_graph *graph) {
@@ -267,11 +270,9 @@ _process_unique_mprs(const struct nhdp_domain *domain, struct neighbor_graph *gr
 /**
  * Selects a subset of nodes from N1 which are maximum 
  * regarding a given property.
- * @param current_mpr_data
- * @param get_property
- * @param candidate_subset
- * @param subset_n1
- * @return 
+ * @param domain NHDP domain for MPR calculation
+ * @param graph neighbor graph instance
+ * @param get_property callback for querying neighbor graph data
  */
 static void
 _select_greatest_by_property(const struct nhdp_domain *domain,
@@ -349,7 +350,8 @@ _select_greatest_by_property(const struct nhdp_domain *domain,
 
 /**
  * While there exists any element x in N1 with R(x, M) > 0...
- * @param current_mpr_data
+ * @param domain NHDP domain
+ * @param graph neighbor graph instance
  */
 static void
 _process_remaining(const struct nhdp_domain *domain, struct neighbor_graph *graph) {
@@ -418,6 +420,8 @@ _process_remaining(const struct nhdp_domain *domain, struct neighbor_graph *grap
 
 /**
  * Calculate MPR
+ * @param domain NHDP domain
+ * @param graph neighbor graph instance
  */
 void
 mpr_calculate_mpr_rfc7181(const struct nhdp_domain *domain, struct neighbor_graph *graph) {
index b438aa5..e0fe320 100644 (file)
@@ -325,9 +325,7 @@ nhdp_forwarding_selector(struct rfc5444_writer_target *rfc5444_target,
 /**
  * default implementation for rfc5444 forwarding selector to
  * hangle dualstack correctly
- * @param writer rfc5444 writer
- * @param target rfc5444 target
- * @param ptr custom pointer, contains rfc5444 target
+ * @param rfc5444_target rfc5444 target
  * @return true if target corresponds to selection
  */
 static bool
index c444dee..ed99921 100644 (file)
@@ -394,8 +394,8 @@ nhdp_db_neighbor_addr_remove(struct nhdp_naddr *naddr) {
 
 /**
  * Moves a nhdp neighbor address to a different neighbor
- * @param neigh
- * @param naddr
+ * @param neigh nhdp neighbor
+ * @param naddr nhdp neighbor address
  */
 void
 nhdp_db_neighbor_addr_move(struct nhdp_neighbor *neigh, struct nhdp_naddr *naddr) {
@@ -688,8 +688,8 @@ nhdp_db_link_addr_remove(struct nhdp_laddr *laddr) {
 
 /**
  * Moves a nhdp link address to a different link
- * @param lnk
- * @param laddr
+ * @param lnk NHDP link 
+ * @param laddr NHDP link address
  */
 void
 nhdp_db_link_addr_move(struct nhdp_link *lnk, struct nhdp_laddr *laddr) {
index 68582f4..e89a42f 100644 (file)
@@ -95,10 +95,8 @@ nhdp_hysteresis_get_handler(void) {
 
 /**
  * Dummy function for hysteresis update (does nothing)
- * @param lnk
- * @param context
- * @param vtime
- * @param itime
+ * @param lnk NHDP link
+ * @param context RFC5444 tlvblock reader context
  */
 static void
 _update_hysteresis(struct nhdp_link *lnk __attribute__((unused)),
index 38a7a08..ac13f6f 100644 (file)
@@ -357,7 +357,7 @@ nhdp_interface_get_address_tree(void) {
 /**
  * Add a nhdp interface address to an interface
  * @param interf pointer to nhdp interface
- * @param if_addr address to add to interface
+ * @param addr address to add to interface
  */
 void
 _addr_add(struct nhdp_interface *interf, struct netaddr *addr) {
@@ -421,7 +421,7 @@ _addr_has_been_removed(struct nhdp_interface_addr *addr, uint64_t vtime) {
 
 /**
  * remove address from NHDP interface
- * @param ptr pointer to nhdp interface address
+ * @param addr nhdp interface address
  */
 static void
 _remove_addr(struct nhdp_interface_addr *addr) {
@@ -450,7 +450,6 @@ _cb_addr_timeout(struct oonf_timer_instance *ptr) {
  * AVL tree comparator for netaddr objects.
  * @param k1 pointer to key 1
  * @param k2 pointer to key 2
- * @param ptr not used in this comparator
  * @return +1 if k1>k2, -1 if k1<k2, 0 if k1==k2
  */
 static int
index 759498b..28f83d0 100644 (file)
@@ -186,7 +186,7 @@ EXPORT struct avl_tree *nhdp_interface_get_tree(void);
 EXPORT struct avl_tree *nhdp_interface_get_address_tree(void);
 
 /**
- * @param interface name
+ * @param name interface name
  * @return nhdp interface, NULL if not found
  */
 static INLINE struct nhdp_interface *
@@ -218,7 +218,7 @@ nhdp_interface_addr_if_get(const struct nhdp_interface *interf, const struct net
 }
 
 /**
- * @param network address
+ * @param addr network address
  * @return nhdp interface address
  */
 static INLINE struct nhdp_interface_addr *
@@ -274,7 +274,7 @@ nhdp_interface_remove_l2hop(struct nhdp_l2hop *twohop) {
 
 /**
  * Attach a link address to the local nhdp interface
- * @param laddr
+ * @param laddr NHDP link address
  */
 static INLINE void
 nhdp_interface_add_laddr(struct nhdp_laddr *laddr) {
@@ -283,7 +283,7 @@ nhdp_interface_add_laddr(struct nhdp_laddr *laddr) {
 
 /**
  * Detach a link address from the local nhdp interface
- * @param laddr
+ * @param laddr NHDP link address
  */
 static INLINE void
 nhdp_interface_remove_laddr(struct nhdp_laddr *laddr) {
index 589dd82..9b437fe 100644 (file)
@@ -250,7 +250,7 @@ _cleanup_error(void) {
  * Process an address with a LOCAL_IF TLV
  * @param addr pointer to netaddr object with address
  * @param local_if value of LOCAL_IF TLV
- * @return
+ * @return RFC5444 processing result
  */
 static enum rfc5444_result
 _pass2_process_localif(struct netaddr *addr, uint8_t local_if) {
@@ -360,8 +360,7 @@ _handle_originator(struct rfc5444_reader_tlvblock_context *context) {
 
 /**
  * Handle in HELLO messages and its TLVs
- * @param consumer tlvblock consumer
- * @param context message context
+ * @param context tlvblock reader context
  * @return see rfc5444_result enum
  */
 static enum rfc5444_result
@@ -471,6 +470,11 @@ _cb_messagetlvs(struct rfc5444_reader_tlvblock_context *context) {
   return RFC5444_OKAY;
 }
 
+/**
+ * Called if the constraints for the tlv block are not valid
+ * @param context tlv block reader context
+ * @return see rfc5444_result enum
+ */
 static enum rfc5444_result
 _cb_failed_constraints(struct rfc5444_reader_tlvblock_context *context __attribute__((unused))) {
 #ifdef OONF_LOG_INFO
@@ -486,9 +490,8 @@ _cb_failed_constraints(struct rfc5444_reader_tlvblock_context *context __attribu
 
 /**
  * Process addresses of NHDP Hello message to determine link/neighbor status
- * @param consumer
- * @param context
- * @return
+ * @param context tlv block reader context
+ * @return see rfc5444_result enum
  */
 static enum rfc5444_result
 _cb_addresstlvs_pass1(struct rfc5444_reader_tlvblock_context *context) {
@@ -590,10 +593,9 @@ _cb_addresstlvs_pass1(struct rfc5444_reader_tlvblock_context *context) {
 /**
  * Handle end of message for pass1 processing. Create link/neighbor if necessary,
  * mark addresses as potentially lost.
- * @param consumer
- * @param context
- * @param dropped
- * @return
+ * @param context tlv block reader context
+ * @param dropped true if block was dropped by another callback
+ * @return see rfc5444_result enum
  */
 static enum rfc5444_result
 _cb_addresstlvs_pass1_end(struct rfc5444_reader_tlvblock_context *context, bool dropped) {
@@ -793,9 +795,8 @@ _process_domainspecific_2hopdata(struct nhdp_l2hop *l2hop,
 /**
  * Second pass for processing the addresses of the NHDP Hello. This one will update
  * the database
- * @param consumer
- * @param context
- * @return
+ * @param context tlv block reader context
+ * @return see rfc5444_result enum
  */
 static enum rfc5444_result
 _cb_addr_pass2_block(struct rfc5444_reader_tlvblock_context *context) {
@@ -872,10 +873,9 @@ _cb_addr_pass2_block(struct rfc5444_reader_tlvblock_context *context) {
 
 /**
  * Finalize changes of the database and update the status of the link
- * @param consumer
- * @param context
- * @param dropped
- * @return
+ * @param context tlv block reader context
+ * @param dropped true if context was dropped by a callback
+ * @return see rfc5444_result enum
  */
 static enum rfc5444_result
 _cb_msg_pass2_end(struct rfc5444_reader_tlvblock_context *context, bool dropped) {
index 0c959fd..d5876f9 100644 (file)
@@ -204,8 +204,8 @@ nhdp_writer_set_mac_TLV_state(bool active) {
 
 /**
  * Callback to initialize the message header for a HELLO message
- * @param writer
- * @param message
+ * @param writer RFC5444 writer instance
+ * @param message RFC5444 message
  */
 static int
 _cb_addMessageHeader(struct rfc5444_writer *writer,
@@ -252,8 +252,7 @@ _cb_addMessageHeader(struct rfc5444_writer *writer,
 
 /**
  * Callback to add the message TLVs to a HELLO message
- * @param writer
- * @param prv
+ * @param writer RFC5444 writer
  */
 static void
 _cb_addMessageTLVs(struct rfc5444_writer *writer) {
@@ -320,10 +319,10 @@ _cb_addMessageTLVs(struct rfc5444_writer *writer) {
 
 /**
  * Add a rfc5444 address with localif TLV to the stream
- * @param writer
- * @param prv
- * @param interf
- * @param addr
+ * @param writer RFC5444 writer instance
+ * @param prv RFC5444 content provider instance
+ * @param interf NHDP interface
+ * @param addr NHDP interface address
  */
 static void
 _add_localif_address(struct rfc5444_writer *writer, struct rfc5444_writer_content_provider *prv,
@@ -361,10 +360,10 @@ _add_localif_address(struct rfc5444_writer *writer, struct rfc5444_writer_conten
 
 /**
  * Add a rfc5444 address with link_status or other_neigh TLV to the stream
- * @param writer
- * @param prv
- * @param interf
- * @param naddr
+ * @param writer RFC5444 writer instance
+ * @param prv RFC5444 content provider instance
+ * @param interf NHDP interface
+ * @param naddr NHDP interface address
  */
 static void
 _add_link_address(struct rfc5444_writer *writer, struct rfc5444_writer_content_provider *prv,
@@ -449,11 +448,11 @@ _add_link_address(struct rfc5444_writer *writer, struct rfc5444_writer_content_p
 
 /**
  * Write up to four metric TLVs to an address
- * @param writer rfc5444 writer
+ * @param writer rfc5444 writer instance
  * @param addr rfc5444 address
- * @param neigh pointer to symmetric neighbor, might be NULL
- * @param lnk pointer to symmetric link, might be NULL
- * @param handler pointer to link metric handler
+ * @param neigh symmetric NHDP neighbor, might be NULL
+ * @param lnk symmetric NHDP link, might be NULL
+ * @param domain NHDP domain
  */
 static void
 _write_metric_tlv(struct rfc5444_writer *writer, struct rfc5444_writer_address *addr,
@@ -549,7 +548,7 @@ _write_metric_tlv(struct rfc5444_writer *writer, struct rfc5444_writer_address *
 }
 /**
  * Callback to add the addresses and address TLVs to a HELLO message
- * @param writer
+ * @param writer RFC5444 writer instance
  */
 void
 _cb_addAddresses(struct rfc5444_writer *writer) {
index 7d77062..32106fc 100644 (file)
@@ -162,9 +162,8 @@ _cleanup(void) {
 
 /**
  * Callback triggered when a NHDP hello message is received by the stack
- * @param consumer
- * @param context
- * @return
+ * @param context rfc5444 tlvblock reader context
+ * @return see rfc5444_result enum
  */
 static enum rfc5444_result
 _cb_message_start_callback(struct rfc5444_reader_tlvblock_context *context) {
@@ -202,9 +201,8 @@ _cb_message_start_callback(struct rfc5444_reader_tlvblock_context *context) {
 
 /**
  * Callblack triggered to deliver the message TLVs received in a NHDP Hello
- * @param consumer
- * @param context
- * @return
+ * @param context rfc5444 tlvblock reader context
+ * @return see rfc5444_result enum
  */
 static enum rfc5444_result
 _cb_messagetlvs(struct rfc5444_reader_tlvblock_context *context __attribute__((unused))) {
@@ -253,9 +251,8 @@ _cb_messagetlvs(struct rfc5444_reader_tlvblock_context *context __attribute__((u
 
 /**
  * Callblack triggered to deliver the address TLVs received in a NHDP Hello
- * @param consumer
- * @param context
- * @return
+ * @param context rfc5444 tlvblock reader context
+ * @return see rfc5444_result enum
  */
 
 static enum rfc5444_result
index 41df8a1..7fc54c0 100644 (file)
@@ -226,8 +226,8 @@ _cb_query(struct os_route *filter __attribute__((unused)), struct os_route *rout
 
 /**
  * Dummy cb_finished callback for wildcard query
- * @param route
- * @param error
+ * @param route route that was finished
+ * @param error error code
  */
 static void
 _cb_query_finished(struct os_route *route __attribute__((unused)),
index 80685cc..31433f2 100644 (file)
@@ -902,7 +902,8 @@ _print_routing_tree(struct json_session *session,
 
 /**
  * Print all JSON routes
- * @param session
+ * @param session json session
+ * @param filter filter value to select domain
  */
 static void
 _create_route_json(struct json_session *session, const char *filter) {
index 7530340..972dd7a 100644 (file)
@@ -383,9 +383,9 @@ olsrv2_is_routable(struct netaddr *addr) {
 /**
  * default implementation for rfc5444 processing handling according
  * to MPR settings.
- * @param context
- * @param vtime
- * @return
+ * @param context RFC5444 tlvblock reader context
+ * @param vtime validity time for duplicate entry data
+ * @return true if TC should be processed, false otherwise
  */
 bool
 olsrv2_mpr_shall_process(
@@ -899,7 +899,7 @@ _update_originator(int af_family) {
 
 /**
  * Callback for interface events
- * @param listener pointer to interface listener
+ * @param if_listener interface listener
  * @return always 0
  */
 static int
index dc96cfc..7223d49 100644 (file)
@@ -209,7 +209,7 @@ _remember_removed_originator(struct netaddr *originator, uint64_t vtime) {
  * @param af_type address family type of the originator
  *   (AF_INET or AF_INET6)
  * @param setting pointer to the storage of the originator
- * @param originator new originator
+ * @param new_originator new originator
  */
 static void
 _set_originator(int af_type, struct netaddr *setting, const struct netaddr *new_originator) {
index 13ec129..2a70161 100644 (file)
@@ -185,8 +185,8 @@ olsrv2_reader_cleanup(void) {
 
 /**
  * Callback that parses message TLVs of TC
- * @param context
- * @return
+ * @param context RFC5444 tlvblock reader context
+ * @return see rfc5444_result enum
  */
 static enum rfc5444_result
 _cb_messagetlvs(struct rfc5444_reader_tlvblock_context *context) {
@@ -331,8 +331,8 @@ _cb_messagetlvs(struct rfc5444_reader_tlvblock_context *context) {
 
 /**
  * Callback that parses address TLVs of TC
- * @param context
- * @return
+ * @param context RFC5444 tlvblock reader context
+ * @return see rfc5444_result enum
  */
 static enum rfc5444_result
 _cb_addresstlvs(struct rfc5444_reader_tlvblock_context *context __attribute__((unused))) {
@@ -512,9 +512,9 @@ _handle_gateways(struct rfc5444_reader_tlvblock_entry *tlv,
 
 /**
  * Callback that is called when message parsing of TLV is finished
- * @param context
- * @param dropped
- * @return
+ * @param context tlv block reader context
+ * @param dropped true if context was dropped by a callback
+ * @return see rfc5444_result enum
  */
 static enum rfc5444_result
 _cb_messagetlvs_end(struct rfc5444_reader_tlvblock_context *context __attribute__((unused)),
index d4adf1f..df8adb0 100644 (file)
@@ -473,16 +473,16 @@ _remove_entry(struct olsrv2_routing_entry *entry) {
  * Insert a new entry into the dijkstra working queue
  * @param target pointer to tc target
  * @param neigh next hop through which the target can be reached
- * @param linkcost cost of the last hop of the path towards the target
- * @param pathcost remainder of the cost to the target
+ * @param link_cost cost of the last hop of the path towards the target
+ * @param path_cost remainder of the cost to the target
  * @param distance hopcount to be used for the route to the target
  * @param single_hop true if this is a single-hop route, false otherwise
- * @param last_node address of the last originator before we reached the
+ * @param last_originator address of the last originator before we reached the
  *   destination prefix
  */
 static void
 _insert_into_working_tree(struct olsrv2_tc_target *target,
-    struct nhdp_neighbor *neigh, uint32_t linkcost,
+    struct nhdp_neighbor *neigh, uint32_t link_cost,
     uint32_t path_cost, uint8_t path_hops,
     uint8_t distance, bool single_hop,
     const struct netaddr *last_originator) {
@@ -490,7 +490,7 @@ _insert_into_working_tree(struct olsrv2_tc_target *target,
 #ifdef OONF_LOG_DEBUG_INFO
   struct netaddr_str nbuf1, nbuf2;
 #endif
-  if (linkcost > RFC7181_METRIC_MAX) {
+  if ( link_cost > RFC7181_METRIC_MAX) {
     return;
   }
 
@@ -505,7 +505,7 @@ _insert_into_working_tree(struct olsrv2_tc_target *target,
   }
 
   /* calculate new total pathcost */
-  path_cost += linkcost;
+  path_cost += link_cost;
   path_hops += 1;
 
   if (avl_is_node_added(&node->_node)) {
@@ -646,8 +646,6 @@ _update_routing_entry(struct nhdp_domain *domain,
 /**
  * Initialize internal fields for dijkstra calculation
  * @param domain nhdp domain
- * @return true if source-specific and non-source specific can
- *   be handled in the same dijkstra run, false otherwise
  */
 static void
 _prepare_routes(struct nhdp_domain *domain) {
@@ -661,9 +659,6 @@ _prepare_routes(struct nhdp_domain *domain) {
 
 /**
  * Initialize internal fields for dijkstra calculation
- * @param domain nhdp domain
- * @return true if source-specific and non-source specific can
- *   be handled in the same dijkstra run, false otherwise
  */
 static void
 _prepare_nodes(void) {
@@ -781,6 +776,8 @@ _add_one_hop_nodes(struct nhdp_domain *domain, int af_family,
 /**
  * Remove item from dijkstra working queue and process it
  * @param domain nhdp domain
+ * @param use_non_ss include non-source-specific nodes into working list
+ * @param use_ss include source-specific nodes into working list
  */
 static void
 _handle_working_queue(struct nhdp_domain *domain,
@@ -1100,7 +1097,7 @@ _cb_trigger_dijkstra(struct oonf_timer_instance *ptr __attribute__((unused))) {
 
 /**
  * Callback triggered when neighbor metrics are updates
- * @param neigh
+ * @param neigh NHDP neighbor
  */
 static void
 _cb_nhdp_update(struct nhdp_neighbor *neigh __attribute__((unused))) {
@@ -1109,7 +1106,7 @@ _cb_nhdp_update(struct nhdp_neighbor *neigh __attribute__((unused))) {
 
 /**
  * Callback for kernel route processing results
- * @param route pointer to kernel route
+ * @param route OS route data
  * @param error 0 if no error happened
  */
 static void
index 52e11bd..d1aee18 100644 (file)
@@ -223,8 +223,8 @@ _send_tc(int af_type) {
 
 /**
  * Callback for rfc5444 writer to add message header for tc
- * @param writer
- * @param message
+ * @param writer RFC5444 writer instance
+ * @param message RFC5444 message that is generated
  */
 static int
 _cb_addMessageHeader(struct rfc5444_writer *writer,
@@ -263,7 +263,7 @@ _cb_finishMessageHeader(struct rfc5444_writer *writer,
 
 /**
  * Callback for rfc5444 writer to add message tlvs to tc
- * @param writer
+ * @param writer RFC5444 writer instance
  */
 static void
 _cb_addMessageTLVs(struct rfc5444_writer *writer) {
@@ -371,7 +371,7 @@ _generate_neighbor_metric_tlvs(struct rfc5444_writer *writer,
 
 /**
  * Callback for rfc5444 writer to add addresses and addresstlvs to tc
- * @param writer
+ * @param writer RFC5444 writer instance
  */
 static void
 _cb_addAddresses(struct rfc5444_writer *writer) {
@@ -552,10 +552,10 @@ _cb_addAddresses(struct rfc5444_writer *writer) {
 
 /**
  * Callback triggered when tc is finished.
- * @param writer
- * @param start
- * @param end
- * @param complete
+ * @param writer RFC5444 writer instance
+ * @param start first address contained in generated message
+ * @param end last address contained in generated message
+ * @param complete true if all addresses are in message, false otherwise
  */
 static void
 _cb_finishMessageTLVs(struct rfc5444_writer *writer,
index 7f8e87a..65ab84f 100644 (file)
@@ -457,8 +457,8 @@ _cb_olsrv2info_help(struct oonf_telnet_data *con) {
 }
 
 /**
- * Initialize the value buffers for a NHDP interface address
- * @param if_addr interface NHDP address
+ * Initialize the value buffers for an originator entry
+ * @param af_type address family of originator
  */
 static void
 _initialize_originator_values(int af_type) {
@@ -467,8 +467,8 @@ _initialize_originator_values(int af_type) {
 }
 
 /**
- * Initialize the value buffers for a NHDP interface address
- * @param if_addr interface NHDP address
+ * Initialize the value buffer for old originator entries
+ * @param entry originator set entry
  */
 static void
 _initialize_old_originator_values(struct olsrv2_originator_set_entry *entry) {
index 9b70642..2282170 100644 (file)
@@ -193,7 +193,7 @@ _cleanup(void) {
 /**
  * Callback for Dijkstra code to see which route should be changed
  * @param domain pointer to domain of route
- * @param route routing data
+ * @param route_param routing data
  * @param set true if route will be set, false otherwise
  * @return always true (we never drop a route)
  */
index f06f105..9f0ba01 100644 (file)
@@ -200,7 +200,7 @@ oonf_clock_fromIntervalString(uint64_t *result, const char *string) {
 
 /**
  * Returns a timestamp s seconds in the future
- * @param s milliseconds until timestamp
+ * @param relative milliseconds until timestamp
  * @return absolute time when event will happen
  */
 static INLINE uint64_t
index 544ac62..454e6ff 100644 (file)
@@ -447,7 +447,7 @@ _cb_receive_data(struct oonf_stream_session *session) {
 
 /**
  * Close file transfer descriptor during cleanup
- * @param session
+ * @param session stream session to be cleaned up
  */
 static void
 _cb_cleanup_session(struct oonf_stream_session *session) {
index 52b2535..a479832 100644 (file)
@@ -521,7 +521,6 @@ _handle_errno1(struct oonf_packet_socket *pktsocket,
 /**
  * Apply a new configuration to all attached sockets
  * @param managed pointer to managed socket
- * @param config pointer to configuration
  * @return -1 if an error happened, 0 otherwise
  */
 static int
@@ -555,13 +554,13 @@ _apply_managed(struct oonf_packet_managed *managed) {
 
 /**
  * Apply a new configuration to an unicast/multicast socket pair
- * @param managed pointer to managed socket
- * @param data pointer to interface to bind sockets, NULL if unbound socket
- * @param sock pointer to unicast packet socket
- * @param bind_ip address to bind unicast socket to
+ * @param managed managed socket
+ * @param os_if OS interface to bind sockets, NULL if unbound socket
+ * @param changed buffer for boolean, will be set to true if sockets changed
+ * @param sock unicast packet socket
  * @param mc_sock pointer to multicast packet socket
  * @param mc_ip multicast address
- * @return
+ * @return 0 if okay, -1 if an error happened
  */
 static int
 _apply_managed_socketpair(int af_type, struct oonf_packet_managed *managed,
@@ -675,8 +674,8 @@ _apply_managed_socketpair(int af_type, struct oonf_packet_managed *managed,
 
 /**
  * Apply new configuration to a managed stream socket
- * @param managed pointer to managed stream
- * @param stream pointer to TCP stream to configure
+ * @param managed managed packet socket (pair)
+ * @param packet packet socket
  * @param bindto local address to bind socket to
  *   set to AF_UNSPEC for simple reinitialization
  * @param port local port number
@@ -761,10 +760,7 @@ _apply_managed_socket(struct oonf_packet_managed *managed,
 
 /**
  * callback for unicast events in socket scheduler
- * @param fd
- * @param data
- * @param event_read
- * @param event_write
+ * @param entry socket entry that fired event
  */
 static void
 _cb_packet_event_unicast(struct oonf_socket_entry *entry) {
@@ -773,10 +769,7 @@ _cb_packet_event_unicast(struct oonf_socket_entry *entry) {
 
 /**
  * callback for multicast events in socket scheduler
- * @param fd
- * @param data
- * @param event_read
- * @param event_write
+ * @param entry socket entry that fired event
  */
 static void
 _cb_packet_event_multicast(struct oonf_socket_entry *entry) {
@@ -785,10 +778,9 @@ _cb_packet_event_multicast(struct oonf_socket_entry *entry) {
 
 /**
  * Callback to handle data from the olsr socket scheduler
- * @param fd filedescriptor to read data from
- * @param data custom data pointer
- * @param event_read true if read-event is incoming
- * @param event_write true if write-event is incoming
+ * @param entry socket entry that fired event
+ * @param multicast true if the multicast socket fired the event,
+ *   false otherwise
  */
 static void
 _cb_packet_event(struct oonf_socket_entry *entry,
@@ -891,7 +883,7 @@ _cb_packet_event(struct oonf_socket_entry *entry,
 
 /**
  * Callbacks for events on the interface
- * @param l
+ * @param l OS interface listener
  * @return -1 if an error happened, 0 otherwise
  */
 static int
index 06700c4..0f8b7bb 100644 (file)
@@ -1144,9 +1144,9 @@ _cb_receive_data(struct oonf_packet_socket *sock,
 /**
  * Callback for sending a multicast packet to a rfc5444 target
  * @param writer rfc5444 writer
- * @param interf rfc5444 interface
+ * @param target rfc5444 target
  * @param ptr pointer to outgoing buffer
- * @param size_t length of buffer
+ * @param len length of buffer
  */
 static void
 _cb_send_multicast_packet(struct rfc5444_writer *writer __attribute__((unused)),
@@ -1176,9 +1176,9 @@ _cb_send_multicast_packet(struct rfc5444_writer *writer __attribute__((unused)),
 /**
  * Callback for sending an unicast packet to a rfc5444 target
  * @param writer rfc5444 writer
- * @param interf rfc5444 interface
+ * @param target rfc5444 target
  * @param ptr pointer to outgoing buffer
- * @param size_t length of buffer
+ * @param len length of buffer
  */
 static void
 _cb_send_unicast_packet(struct rfc5444_writer *writer __attribute__((unused)),
@@ -1207,9 +1207,9 @@ _cb_send_unicast_packet(struct rfc5444_writer *writer __attribute__((unused)),
 
 /**
  * Handle forwarding of rfc5444 messages
- * @param context
- * @param buffer
- * @param length
+ * @param context RFC5444 tlvblock reader context
+ * @param buffer message to be forwarded
+ * @param length length of message
  */
 static void
 _cb_forward_message(
@@ -1260,7 +1260,7 @@ _cb_single_target_selector(struct rfc5444_writer *writer __attribute__((unused))
 /**
  * Selector for outgoing target
  * @param writer rfc5444 writer
- * @param target rfc5444 target
+ * @param rfc5444_target rfc5444 target
  * @param ptr custom pointer, contains rfc5444 target
  * @return true if target corresponds to selection
  */
@@ -1332,7 +1332,7 @@ _alloc_addrtlv_entry(void) {
 
 /**
  * Free an addrblock entry
- * @param pointer to addrblock
+ * @param addrblock addressblock to be freed
  */
 static void
 _free_addrblock_entry(struct rfc5444_reader_addrblock_entry* addrblock) {
@@ -1341,7 +1341,7 @@ _free_addrblock_entry(struct rfc5444_reader_addrblock_entry* addrblock) {
 
 /**
  * Free a tlvblock entry
- * @param pointer to tlvblock
+ * @param tlvblock tlvblock to be freed
  */
 static void
 _free_tlvblock_entry(struct rfc5444_reader_tlvblock_entry *tlvblock) {
@@ -1349,8 +1349,8 @@ _free_tlvblock_entry(struct rfc5444_reader_tlvblock_entry *tlvblock) {
 }
 
 /**
- * Free a tlvblock entry
- * @param pointer to tlvblock
+ * Free an address
+ * @param address address to be freed
  */
 static void
 _free_address_entry(struct rfc5444_writer_address *address) {
@@ -1358,8 +1358,8 @@ _free_address_entry(struct rfc5444_writer_address *address) {
 }
 
 /**
- * Free a tlvblock entry
- * @param pointer to tlvblock
+ * Free an address tlv entry
+ * @param addrtlv address tlv entry to be freed
  */
 static void
 _free_addrtlv_entry(struct rfc5444_writer_addrtlv *addrtlv) {
@@ -1369,7 +1369,7 @@ _free_addrtlv_entry(struct rfc5444_writer_addrtlv *addrtlv) {
 /**
  * Callback to add sequence number to outgoing RFC5444 packet
  * @param writer pointer to rfc5444 writer
- * @param interf pointer to rfc5444 interface
+ * @param rfc5444_target rfc5444 target where the packet will be sent to
  */
 static void
 _cb_add_seqno(struct rfc5444_writer *writer, struct rfc5444_writer_target *rfc5444_target) {
@@ -1479,7 +1479,7 @@ interface_changed_cleanup:
 
 /**
  * Interface settings of a rfc5444 interface changed
- * @param managed
+ * @param managed managed socket which interface changed
  * @param changed true if socket addresses changed
  */
 static void
index b4f4f20..a242b0a 100644 (file)
@@ -324,7 +324,7 @@ oonf_rfc5444_get_target_from_writer(struct rfc5444_writer *writer) {
 }
 
 /**
- * @param writer pointer to rfc5444 target
+ * @param target rfc5444 writer target
  * @return pointer to oonf_rfc5444 target
  */
 static INLINE struct oonf_rfc5444_target *
@@ -385,7 +385,7 @@ oonf_rfc5444_remove_protocol_pktseqno(struct oonf_rfc5444_protocol *protocol) {
 
 /**
  * Request packet sequence number for a target
- * @param protocol pointer to rfc5444 protocol instance
+ * @param target rfc5444 target
  */
 static INLINE void
 oonf_rfc5444_add_target_pktseqno(struct oonf_rfc5444_target *target) {
@@ -394,7 +394,7 @@ oonf_rfc5444_add_target_pktseqno(struct oonf_rfc5444_target *target) {
 
 /**
  * Release the request for a packet sequence number for a target
- * @param protocol pointer to rfc5444 protocol instance
+ * @param target rfc5444 target
  */
 static INLINE void
 oonf_rfc5444_remove_target_pktseqno(struct oonf_rfc5444_target *target) {
index c63c02f..2101a7e 100644 (file)
@@ -141,7 +141,6 @@ _initiate_shutdown(void) {
  * Add a socket handler to the scheduler
  *
  * @param entry pointer to initialized socket entry
- * @return -1 if an error happened, 0 otherwise
  */
 void
 oonf_socket_add(struct oonf_socket_entry *entry)
index ce8895f..daf6e36 100644 (file)
@@ -712,10 +712,7 @@ _cb_timeout_handler(struct oonf_timer_instance *ptr) {
 
 /**
  * Handle events for TCP session from network scheduler
- * @param fd filedescriptor of TCP session
- * @param data custom data
- * @param event_read true if read-event is incoming
- * @param event_write true if write-event is incoming
+ * @param entry socket entry to be parsed
  */
 static void
 _cb_parse_connection(struct oonf_socket_entry *entry) {
@@ -884,7 +881,7 @@ _cb_parse_connection(struct oonf_socket_entry *entry) {
 
 /**
  * Callbacks for events on the interface
- * @param l
+ * @param interf os interface listener that fired
  * @return -1 if an error happened, 0 otherwise
  */
 static int
index 0859ec0..06d5bc5 100644 (file)
@@ -267,8 +267,8 @@ oonf_telnet_execute(const char *cmd, const char *para,
 
 /**
  * AVL tree comparator for first word in case insensitive strings.
- * @param txt1 pointer to string 1
- * @param txt2 pointer to string 2
+ * @param ptr1 pointer to string 1
+ * @param ptr2 pointer to string 2
  * @return +1 if k1>k2, -1 if k1<k2, 0 if k1==k2
  */
 static int
index fe90675..f062b60 100644 (file)
@@ -345,11 +345,9 @@ oonf_timer_get_list(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 random_val cached random variable to calculate jitter
- * @return the absolute time when timer will fire
+ * calculate the absolute time when a timer should fire, incuding jitter
+ * @param timer timer instance that will be initialized
+ * @param rel_time relative time until timer should fire
  */
 static void
 _calc_clock(struct oonf_timer_instance *timer, uint64_t rel_time)
@@ -379,9 +377,9 @@ _calc_clock(struct oonf_timer_instance *timer, uint64_t rel_time)
 
 /**
  * Custom AVL comparator for two timer entries.
- * @param p1
- * @param p2
- * @return
+ * @param p1 first timer entry
+ * @param p2 second timer entry
+ * @return -1/0/1 depending on comparision of time when timer fires
  */
 static int
 _avlcomp_timer(const void *p1, const void *p2) {
index 38cd187..3375566 100644 (file)
@@ -187,7 +187,7 @@ oonf_timer_start(struct oonf_timer_instance *timer, uint64_t rel_time) {
 }
 
 /**
- * @param timer pointer to timer class
+ * @param tc timer class
  * @return number of timers currently in use
  */
 static INLINE uint32_t
@@ -196,7 +196,7 @@ oonf_timer_get_usage(struct oonf_timer_class *tc) {
 }
 
 /**
- * @param timer pointer to timer class
+ * @param tc timer class
  * @return number of times the timer was reset
  */
 static INLINE uint32_t
@@ -205,7 +205,7 @@ oonf_timer_get_changes(struct oonf_timer_class *tc) {
 }
 
 /**
- * @param timer pointer to timer class
+ * @param tc timer class
  * @return number of times the timer was fired
  */
 static INLINE uint32_t
@@ -214,7 +214,7 @@ oonf_timer_get_fired(struct oonf_timer_class *tc) {
 }
 
 /**
- * @param timer pointer to timer class
+ * @param tc timer class
  * @return number of times the timer took more than a timeslice
  */
 static INLINE uint32_t
index 50a8ba3..7af7ba8 100644 (file)
@@ -106,9 +106,8 @@ _cleanup(void) {
  *     be printed
  * @param out pointer to output buffer
  * @param format pointer to template for output, not used for JSON output
- * @return
  */
-int
+void
 oonf_viewer_output_prepare(struct oonf_viewer_template *template,
     struct abuf_template_storage *storage,
     struct autobuf *out, const char *format) {
index e9f14de..34be0aa 100644 (file)
@@ -124,7 +124,7 @@ struct oonf_viewer_template {
   struct json_session _json;
 };
 
-EXPORT int oonf_viewer_output_prepare(struct oonf_viewer_template *template,
+EXPORT void oonf_viewer_output_prepare(struct oonf_viewer_template *template,
     struct abuf_template_storage *storage, struct autobuf *out, const char *format);
 EXPORT void oonf_viewer_output_print_line(struct oonf_viewer_template *template);
 EXPORT void oonf_viewer_output_finish(struct oonf_viewer_template *template);
index dbe21ee..ab8253f 100644 (file)
@@ -274,7 +274,7 @@ os_fd_get_fd(struct os_fd *sock) {
  * Copy a filedescriptor
  * @param dst target filedescriptor
  * @param from source filedescriptor
- * @return
+ * @return -1 if an error happened, 0 otherwise
  */
 static INLINE int
 os_fd_copy(struct os_fd *dst, struct os_fd *from) {
@@ -287,11 +287,11 @@ os_fd_copy(struct os_fd *dst, struct os_fd *from) {
  * @return -1 if an error happened, 0 otherwise
  */
 static INLINE int
-os_fd_close(struct os_fd *sock) {
+os_fd_close(struct os_fd *fd ) {
   int result = 0;
-  if (sock->fd != -1) {
-    result = close(sock->fd);
-    sock->fd = -1;
+  if ( fd->fd != -1) {
+    result = close( fd->fd);
+        fd->fd = -1;
   }
   return result;
 }
@@ -303,8 +303,8 @@ os_fd_close(struct os_fd *sock) {
  * @return -1 if an error happened, 0 otherwise
  */
 static INLINE int
-os_fd_listen(struct os_fd *sock, int n) {
-  return listen(sock->fd, n);
+os_fd_listen(struct os_fd *fd, int n) {
+  return listen(fd->fd, n);
 }
 
 /**
@@ -456,13 +456,14 @@ os_fd_event_remove(struct os_fd_select *sel) {
  * @return -1 if an error happened, 0 otherwise
  */
 static INLINE int
-os_fd_connect(struct os_fd *sock, const union netaddr_socket *remote) {
-  return connect(sock->fd, &remote->std, sizeof(*remote));
+os_fd_connect(struct os_fd *sockfd, const union netaddr_socket *remote) {
+  return connect(sockfd->fd, &remote->std, sizeof(*remote));
 }
 
 /**
  * Call posix accept()
- * @param sockfd server socket to accept a connection from
+ * @param client storage for filedescriptor for incoming session
+ * @param server server socket to accept a connection from
  * @param incoming buffer for storing the incoming source IP/port
  * @return result of accept() call
  */
@@ -480,19 +481,19 @@ os_fd_accept(struct os_fd *client,
 
 /**
  * Get socket error state
- * @param fd file descriptor of socket
+ * @param sockfd file descriptor of socket
  * @param value buffer to store error state
  * @return result of getsockopt() call
  */
 static INLINE int
-os_fd_get_socket_error(struct os_fd *sock, int *value) {
+os_fd_get_socket_error(struct os_fd *sockfd, int *value) {
   socklen_t len = sizeof(*value);
-  return getsockopt(sock->fd, SOL_SOCKET, SO_ERROR, value, &len);
+  return getsockopt(sockfd->fd, SOL_SOCKET, SO_ERROR, value, &len);
 }
 
 /**
  * Sends data to an UDP socket.
- * @param fd filedescriptor
+ * @param sockfd filedescriptor of UDP socket
  * @param buf buffer for target data
  * @param length length of buffer
  * @param dst pointer to netaddr socket to send packet to
@@ -500,15 +501,15 @@ os_fd_get_socket_error(struct os_fd *sock, int *value) {
  * @return same as sendto()
  */
 static INLINE ssize_t
-os_fd_sendto(struct os_fd *sock, const void *buf, size_t length, const union netaddr_socket *dst, bool dont_route) {
-  return sendto(sock->fd, buf, length,
+os_fd_sendto(struct os_fd *sockfd, const void *buf, size_t length, const union netaddr_socket *dst, bool dont_route) {
+  return sendto(sockfd->fd, buf, length,
       dont_route ? MSG_DONTROUTE : 0,
       dst ? &dst->std : NULL, sizeof(*dst));
 }
 
 /**
- * Receive data from a socket.
- * @param fd filedescriptor
+ * Receive data from an UDP socket.
+ * @param sockfd filedescriptor of UDP socket
  * @param buf buffer for incoming data
  * @param length length of buffer
  * @param source pointer to netaddr socket object to store source of packet
@@ -517,21 +518,21 @@ os_fd_sendto(struct os_fd *sock, const void *buf, size_t length, const union net
  * @return same as recvfrom()
  */
 static INLINE ssize_t
-os_fd_recvfrom(struct os_fd *sock, void *buf, size_t length, union netaddr_socket *source,
+os_fd_recvfrom(struct os_fd *sockfd, void *buf, size_t length, union netaddr_socket *source,
     const struct os_interface *interf __attribute__((unused))) {
   socklen_t len = sizeof(*source);
-  return recvfrom(sock->fd, buf, length, 0, &source->std, &len);
+  return recvfrom(sockfd->fd, buf, length, 0, &source->std, &len);
 }
 
 /**
  * Binds a socket to a certain interface
  * @param sock filedescriptor of socket
- * @param interf name of interface
+ * @param interf interface to bind the socket to
  * @return -1 if an error happened, 0 otherwise
  */
 static INLINE int
-os_fd_bindto_interface(struct os_fd *sock, struct os_interface *data) {
-  return setsockopt(sock->fd, SOL_SOCKET, SO_BINDTODEVICE, data->name, strlen(data->name) + 1);
+os_fd_bindto_interface(struct os_fd *sock, struct os_interface *interf) {
+  return setsockopt(sock->fd, SOL_SOCKET, SO_BINDTODEVICE, interf->name, strlen(interf->name) + 1);
 }
 
 /**
@@ -545,10 +546,10 @@ os_fd_get_loopback_name(void) {
 /**
  * send data from one filedescriptor to another one. Linux compatible API
  * structure, might need a bit of work for other OS.
- * @param outfd
- * @param infd
- * @param offset
- * @param count
+ * @param out destination file descriptor
+ * @param in source file descriptor
+ * @param offset offset where to start reading from source
+ * @param count number of bytes to copy
  * @return -1 if an error happened, otherwise the number of bytes that
  *   were sent to outfd
  */
index 25cad0f..63d5496 100644 (file)
@@ -692,7 +692,7 @@ _refresh_mesh(struct os_interface *os_if, char *old_redirect, char *old_spoof) {
 
 /**
  * Cleanup interface after mesh usage
- * @param data network interface data
+ * @param os_if network interface
  */
 static void
 _cleanup_mesh(struct os_interface *os_if) {
@@ -1106,7 +1106,7 @@ _update_address_shortcuts(struct os_interface *os_if) {
  * Add an IP address/prefix to a network interface
  * @param os_if network interface
  * @param prefixed_addr full IP address with prefix length
- * @param address true if this is a peer address, false otherwise
+ * @param peer true if this is a peer address, false otherwise
  */
 static void
 _add_address(struct os_interface *os_if, struct netaddr *prefixed_addr, bool peer) {
@@ -1148,7 +1148,7 @@ _add_address(struct os_interface *os_if, struct netaddr *prefixed_addr, bool pee
  * Remove an IP address/prefix from a network interface
  * @param os_if network interface
  * @param prefixed_addr full IP address with prefix length
- * @param address true if this is a peer address, false otherwise
+ * @param peer true if this is a peer address, false otherwise
  */
 static void
 _remove_address(struct os_interface *os_if, struct netaddr *prefixed_addr, bool peer) {
index 897ab12..89f11d8 100644 (file)
@@ -405,7 +405,7 @@ _routing_finished(struct os_route *route, int error) {
  * Initiatize the an netlink routing message
  * @param msg pointer to netlink message header
  * @param route data to be added to the netlink message
- * @param scope scope of route to be set/removed
+ * @param rt_scope scope of route to be set/removed
  * @return -1 if an error happened, 0 otherwise
  */
 static int
@@ -639,7 +639,7 @@ _match_routes(struct os_route *filter, struct os_route *route) {
 
 /**
  * Handle incoming rtnetlink messages
- * @param msg
+ * @param msg netlink message including header
  */
 static void
 _cb_rtnetlink_message(struct nlmsghdr *msg) {
@@ -671,7 +671,7 @@ _cb_rtnetlink_message(struct nlmsghdr *msg) {
 
 /**
  * Handle incoming rtnetlink messages
- * @param msg
+ * @param msg netlink header including message
  */
 static void
 _cb_rtnetlink_event_message(struct nlmsghdr *msg) {
@@ -700,8 +700,8 @@ _cb_rtnetlink_event_message(struct nlmsghdr *msg) {
 
 /**
  * Handle feedback from netlink socket
- * @param seq
- * @param error
+ * @param seq sequence number of netlink response
+ * @param err error value
  */
 static void
 _cb_rtnetlink_error(uint32_t seq, int err) {
@@ -710,7 +710,6 @@ _cb_rtnetlink_error(uint32_t seq, int err) {
   struct os_route_str rbuf;
 #endif
 
-  /* transform into errno number */
   route = avl_find_element(&_rtnetlink_feedback, &seq, route, _internal._node);
   if (route) {
     OONF_DEBUG(LOG_OS_ROUTING, "Route seqno %u failed: %s (%d) %s",
@@ -741,7 +740,7 @@ _cb_rtnetlink_timeout(void) {
 
 /**
  * Handle done from multipart netlink messages
- * @param seq
+ * @param seq netlink sequence number
  */
 static void
 _cb_rtnetlink_done(uint32_t seq) {
index 7db8747..fe97fda 100644 (file)
@@ -146,8 +146,8 @@ os_routing_is_in_progress(struct os_route *route) {
  * @param listener routing change listener
  */
 static INLINE void
-os_routing_listener_add(struct os_route_listener *l) {
-  os_routing_linux_listener_add(l);
+os_routing_listener_add(struct os_route_listener *listener) {
+  os_routing_linux_listener_add(listener);
 }
 
 /**
@@ -155,8 +155,8 @@ os_routing_listener_add(struct os_route_listener *l) {
  * @param listener routing change listener
  */
 static INLINE void
-os_routing_listener_remove(struct os_route_listener *l) {
-  os_routing_linux_listener_remove(l);
+os_routing_listener_remove(struct os_route_listener *listener) {
+  os_routing_linux_listener_remove(listener);
 }
 
 /**
@@ -172,7 +172,7 @@ os_routing_init_wildcard_route(struct os_route *route) {
 /**
  * Print OS route to string buffer
  * @param buf pointer to string buffer
- * @param route pointer to route
+ * @param route_param route parameters
  * @return pointer to string buffer, NULL if an error happened
  */
 static INLINE const char *
@@ -184,7 +184,7 @@ os_routing_to_string(
 /**
  * Copy one address to 'specific', fill the other one with the
  * fitting IP_ANY value
- * @param ipany buffer for IP_ANY
+ * @param any buffer for IP_ANY
  * @param specific buffer for source
  * @param source source IP value to copy
  */
index 8424b3b..593dcae 100644 (file)
@@ -603,10 +603,7 @@ _netlink_job_finished(struct os_system_netlink *nl) {
 
 /**
  * Handler for incoming netlink messages
- * @param fd
- * @param data
- * @param event_read
- * @param event_write
+ * @param entry OONF socket entry creating the callback
  */
 static void
 _netlink_handler(struct oonf_socket_entry *entry) {
index 3f29da8..1c224d9 100644 (file)
@@ -407,8 +407,8 @@ rfc5444_writer_create_message(struct rfc5444_writer *writer, uint8_t msgid,
 
 /**
  * Single interface selector callback for message creation
- * @param writer
- * @param interf
+ * @param writer RFC5444 writer instance
+ * @param interf RFC5444 writer target
  * @param param pointer to the specified interface
  * @return true if param equals interf, false otherwise
  */
@@ -420,9 +420,9 @@ rfc5444_writer_singletarget_selector(struct rfc5444_writer *writer __attribute__
 
 /**
  * All interface selector callback for message creation
- * @param writer
- * @param interf
- * @param param
+ * @param writer RFC5444 writer instance
+ * @param interf RFC5444 writer target
+ * @param param unused
  * @return always true
  */
 bool rfc5444_writer_alltargets_selector(struct rfc5444_writer *writer __attribute__ ((unused)),
@@ -749,7 +749,7 @@ rfc5444_writer_set_msg_originator(struct rfc5444_writer *writer,
  *
  * @param writer pointer to writer context
  * @param msg pointer to message object
- * @param hopcount
+ * @param hopcount hopcount to set
  */
 void
 rfc5444_writer_set_msg_hopcount(struct rfc5444_writer *writer __attribute__ ((unused)),
@@ -767,7 +767,7 @@ rfc5444_writer_set_msg_hopcount(struct rfc5444_writer *writer __attribute__ ((un
  *
  * @param writer pointer to writer context
  * @param msg pointer to message object
- * @param hoplimit
+ * @param hoplimit hoplimit to set
  */
 void
 rfc5444_writer_set_msg_hoplimit(struct rfc5444_writer *writer __attribute__ ((unused)),
@@ -804,7 +804,6 @@ rfc5444_writer_set_msg_seqno(struct rfc5444_writer *writer __attribute__ ((unuse
  * @param writer pointer to rfc5444 writer
  * @param last_addr pointer to last address object
  * @param common_head length of common head
- * @return common_head (might be modified common_head was 1)
  */
 static void
 _close_addrblock(struct _rfc5444_internal_addr_compress_session *acs,
@@ -846,10 +845,9 @@ _close_addrblock(struct _rfc5444_internal_addr_compress_session *acs,
  *
  * @param acs pointer to address compression session
  * @param writer pointer to rfc5444 writer
- * @param addr pointer to new address
+ * @param addr_list list of addresses
  * @param same_prefixlen number of addresses (up to this) with the same
  *   prefix length
- * @param first true if this is the first address of the message
  * @return new number of messages with same prefix length
  */
 static int
@@ -1133,9 +1131,10 @@ _write_addresstlv(struct rfc5444_writer_tlvtype *tlvtype,
 
 /**
  * Write the address-TLVs of a specific type
- * @param addr_start first address for TLVs
- * @param addr_end last address for TLVs
- * @param tlvtype tlvtype to write into buffer
+ * @param writer RFC5444 writer instance
+ * @param msg RFC5444 message to be generated
+ * @param first first address for TLVs
+ * @param last last address for TLVs
  * @param ptr target buffer pointer
  * @return modified target buffer pointer
  */
@@ -1203,8 +1202,7 @@ _write_addresstlvs(struct rfc5444_writer *writer, struct rfc5444_writer_message
  * Write the address blocks to the message buffer.
  * @param writer pointer to writer context
  * @param msg pointer to message context
- * @param first_addr pointer to first address to be written
- * @param last_addr pointer to last address to be written
+ * @param fragment_addrs list of fragmented addresses
  */
 static void
 _write_addresses(struct rfc5444_writer *writer, struct rfc5444_writer_message *msg,
@@ -1362,7 +1360,7 @@ _write_addresses(struct rfc5444_writer *writer, struct rfc5444_writer_message *m
 /**
  * Write header of message including mandatory tlvblock length field.
  * @param writer pointer to writer context
- * @param _msg pointer to message object
+ * @param msg pointer to message object
  */
 static void
 _write_msgheader(struct rfc5444_writer *writer, struct rfc5444_writer_message *msg) {
@@ -1411,11 +1409,11 @@ _write_msgheader(struct rfc5444_writer *writer, struct rfc5444_writer_message *m
  * Finalize a message fragment, copy it into the packet buffer and
  * cleanup message internal data.
  * @param writer pointer to writer context
- * @param _msg pointer to message object
- * @param first pointer to first address of this fragment
- * @param last pointer to last address of this fragment
+ * @param msg pointer to message object
+ * @param fragment_addrs list of fragmented addresses
  * @param not_fragmented true if this is the only fragment of this message
  * @param useIf pointer to callback for selecting outgoing _targets
+ * @param param custom parameter for callback
  */
 static void
 _finalize_message_fragment(struct rfc5444_writer *writer, struct rfc5444_writer_message *msg,
index a7d5667..f4db8d4 100644 (file)
@@ -315,7 +315,7 @@ rfc5444_writer_set_pkt_seqno(struct rfc5444_writer *writer __attribute__ ((unuse
 
 /**
  * Write the header of a packet into the packet buffer
- * @param writer pointer to writer target object
+ * @param target rfc5444 writer target
  */
 static void
 _write_pktheader(struct rfc5444_writer_target *target) {
index 890114d..d3c686a 100644 (file)
@@ -150,9 +150,8 @@ rfc5444_print_direct(struct autobuf *out, void *buffer, size_t length) {
 
 /**
  * Clear output buffer and print start of packet
- * @param c
- * @param context
- * @return
+ * @param context rfc5444 tlvblock reader context
+ * @return see rfc5444_result enum
  */
 static enum rfc5444_result
 _cb_print_pkt_start(struct rfc5444_reader_tlvblock_context *context) {
@@ -176,10 +175,9 @@ _cb_print_pkt_start(struct rfc5444_reader_tlvblock_context *context) {
 
 /**
  * Print packet TLVs
- * @param c
- * @param tlv
- * @param context
- * @return
+ * @param tlv rfc5444 tlvblock entry
+ * @param context rfc5444 tlvblock reader context
+ * @return see rfc5444_result enum
  */
 enum rfc5444_result
 _cb_print_pkt_tlv(struct rfc5444_reader_tlvblock_entry *tlv,
@@ -206,10 +204,9 @@ _cb_print_pkt_tlv(struct rfc5444_reader_tlvblock_entry *tlv,
 
 /**
  * Print end of packet and call print callback if necessary
- * @param c
- * @param context
- * @param dropped
- * @return
+ * @param context rfc5444 tlvblock reader context
+ * @param dropped unused
+ * @return see rfc5444_result enum
  */
 enum rfc5444_result
 _cb_print_pkt_end(struct rfc5444_reader_tlvblock_context *context,
@@ -227,9 +224,8 @@ _cb_print_pkt_end(struct rfc5444_reader_tlvblock_context *context,
 
 /**
  * Print start of message
- * @param c
- * @param context
- * @return
+ * @param context rfc5444 tlvblock reader context
+ * @return see rfc5444_result enum
  */
 enum rfc5444_result
 _cb_print_msg_start(struct rfc5444_reader_tlvblock_context *context) {
@@ -266,10 +262,9 @@ _cb_print_msg_start(struct rfc5444_reader_tlvblock_context *context) {
 
 /**
  * Print message TLV
- * @param c
- * @param tlv
- * @param context
- * @return
+ * @param tlv tlvblock entry
+ * @param context rfc5444 tlvblock reader context
+ * @return see rfc5444_result enum
  */
 enum rfc5444_result
 _cb_print_msg_tlv(struct rfc5444_reader_tlvblock_entry *tlv,
@@ -296,10 +291,9 @@ _cb_print_msg_tlv(struct rfc5444_reader_tlvblock_entry *tlv,
 
 /**
  * Print end of message
- * @param c
- * @param context
- * @param dropped
- * @return
+ * @param context rfc5444 tlvblock reader context
+ * @param dropped unused
+ * @return see rfc5444_result enum
  */
 enum rfc5444_result
 _cb_print_msg_end(struct rfc5444_reader_tlvblock_context *context,
@@ -316,9 +310,8 @@ _cb_print_msg_end(struct rfc5444_reader_tlvblock_context *context,
 
 /**
  * Print start of address
- * @param c
- * @param context
- * @return
+ * @param context rfc5444 tlvblock reader context
+ * @return see rfc5444_result enum
  */
 enum rfc5444_result
 _cb_print_addr_start(struct rfc5444_reader_tlvblock_context *context) {
@@ -337,10 +330,9 @@ _cb_print_addr_start(struct rfc5444_reader_tlvblock_context *context) {
 
 /**
  * Print address tlv
- * @param c
- * @param tlv
- * @param context
- * @return
+ * @param tlv tlvblock entry
+ * @param context rfc5444 tlvblock reader context
+ * @return see rfc5444_result enum
  */
 enum rfc5444_result
 _cb_print_addr_tlv(struct rfc5444_reader_tlvblock_entry *tlv,
@@ -367,10 +359,9 @@ _cb_print_addr_tlv(struct rfc5444_reader_tlvblock_entry *tlv,
 
 /**
  * Print end of address
- * @param c
- * @param context
- * @param dropped
- * @return
+ * @param context rfc5444 tlvblock reader context
+ * @param dropped unused
+ * @return see rfc5444_result enum
  */
 enum rfc5444_result
 _cb_print_addr_end(struct rfc5444_reader_tlvblock_context *context,
index 68da4e2..d8260bb 100644 (file)
@@ -361,10 +361,9 @@ _calc_tlvblock_intorder(struct rfc5444_reader_tlvblock_entry *entry) {
 }
 
 /**
- * Checks if two internal types have the same tlv type
- * @param int_type1 first internal type
- * @param int_type2 second internal type
- * @param match_ext true if extension type is relevant
+ * Checks if a tlvblock consumer entry to a tlvblock entry
+ * @param tlv tlvlock entry, might be NULL
+ * @param entry tlvblock consumer entry, might be NULL
  * @return <0 if type1<type2, ==0 if type1==type2, >0 if type1>type2
  */
 static int
@@ -611,7 +610,7 @@ cleanup_parse_tlvblock:
  * @param consumer pointer to first consumer for this message type
  * @param context pointer to context for tlv block
  * @param entries pointer avl_tree of tlv block entries
- * @param index of current address inside the addressblock, 0 for message tlv block
+ * @param idx of current address inside the addressblock, 0 for message tlv block
  * @return RFC5444_TLV_DROP_ADDRESS if the current address should
  *   be dropped for later consumers, RFC5444_TLV_DROP_CONTEXT if
  *   the complete message/package should be dropped for
@@ -1278,11 +1277,10 @@ cleanup_parse_message:
 /**
  * Add a tlvblock consumer to a linked list of consumers.
  * The list is kept sorted by the order of the consumers.
- * @param parser pointer to parser context
+ * @param consumer tlvblock consumer entry
  * @param consumer_tree pointer to tree of consumers
  * @param entries pointer to rfc5444_reader_tlvblock_consumer_entry array
  * @param entrycount number of elements in array
- * @param order order of the consumer
  * @return pointer to rfc5444_reader_tlvblock_consumer,
  *   NULL if an error happened
  */
@@ -1329,9 +1327,8 @@ _add_consumer(struct rfc5444_reader_tlvblock_consumer *consumer, struct avl_tree
 
 /**
  * Free a rfc5444_reader_tlvblock_consumer and remove it from its linked list
- * @param parser pointer to parser context
- * @param listhead pointer to listhead pointer
- * @param consumer pointer to rfc5444_reader_tlvblock_consumer
+ * @param consumer_tree tree of tlvblock consumers
+ * @param consumer rfc5444_reader_tlvblock_consumer
  */
 static void
 _free_consumer(struct avl_tree *consumer_tree,
index 1de5086..f9bbba8 100644 (file)
@@ -50,7 +50,7 @@
 #include "rfc5444_context.h"
 #include "rfc5444_api_config.h"
 
-static size_t _calc_tlv_size(bool exttype, size_t length);
+static size_t _calc_tlv_size(bool has_exttype, size_t length);
 static void _write_tlv(uint8_t *ptr, uint8_t type, uint8_t exttype,
     uint8_t idx1, uint8_t idx2, const void *value, size_t length);
 
@@ -162,9 +162,9 @@ _rfc5444_tlv_writer_set(struct rfc5444_tlv_writer_data *data,
  * @param length number of bytes of tlv value, 0 if no value
  * @return number of bytes for TLV including header
  */
-static size_t _calc_tlv_size(bool exttype, size_t length) {
+static size_t _calc_tlv_size(bool has_exttype, size_t length) {
   size_t s = 2;
-  if (exttype) {
+  if (has_exttype) {
     s++;
   }
 
@@ -183,7 +183,7 @@ static size_t _calc_tlv_size(bool exttype, size_t length) {
  * This function does NOT do a length check before writing
  * @param ptr pointer to buffer
  * @param type tlv type
- * @param has_exttype extended tlv type, 0 if no extended type
+ * @param exttype extended tlv type, 0 if no extended type
  * @param idx1 lower index of tlv in address block, 0 if no address tlv
  * @param idx2 upper index of tlv in address block, 255 if no address tlv
  * @param value pointer to tlv value, NULL if no value
index c0da2a7..5e26773 100644 (file)
@@ -276,8 +276,6 @@ rfc5444_writer_add_address(struct rfc5444_writer *writer __attribute__ ((unused)
  * This function must NOT be called from the rfc5444 writer callbacks.
  *
  * @param writer pointer to writer context
- * @param msgtype messagetype for this tlv, -1 to registere a generic
- *   (not message specific) address TLV type
  * @param type pointer to tlvtype structure, type and exttype must be already initialized
  * @param msgtype message type this TLV belongs too, -1 for address TLV
  * @return 0 if addresstlvtype was registered, -1 otherwise
@@ -479,9 +477,9 @@ rfc5444_writer_unregister_postprocessor(struct rfc5444_writer *writer,
 }
 
 /**
- * Registers a new post-processor
+ * Registers a new forward handler
  * @param writer rfc5444 writer
- * @param processor rfc5444 post-processor
+ * @param forward rfc5444 forward handler
  */
 void
 rfc5444_writer_register_forward_handler(struct rfc5444_writer *writer,
@@ -491,9 +489,9 @@ rfc5444_writer_register_forward_handler(struct rfc5444_writer *writer,
 }
 
 /**
- * Unregisters a post-processor
+ * Unregisters a forward handler
  * @param writer rfc5444 writer
- * @param processor rfc5444 post-processor
+ * @param forward rfc5444 forward handler
  */
 void
 rfc5444_writer_unregister_forward_handler(struct rfc5444_writer *writer,
@@ -697,7 +695,7 @@ _rfc5444_writer_free_addresses(struct rfc5444_writer *writer, struct rfc5444_wri
 /**
  * Free message object if not in use anymore
  * @param writer pointer to writer context
- * @param _msg pointer to message object
+ * @param msg pointer to message object
  */
 static void
 _lazy_free_message(struct rfc5444_writer *writer, struct rfc5444_writer_message *msg) {