Fixes for doxygen warnings
authorHenning Rogge <henning.rogge@fkie.fraunhofer.de>
Thu, 20 Aug 2015 12:44:34 +0000 (14:44 +0200)
committerHenning Rogge <henning.rogge@fkie.fraunhofer.de>
Thu, 20 Aug 2015 12:44:34 +0000 (14:44 +0200)
27 files changed:
src-api/common/isonumber.c
src-api/config/cfg_schema.c
src-api/core/oonf_logging.c
src-api/core/oonf_subsystem.c
src-plugins/generic/dlep/dlep_session.c
src-plugins/generic/dlep/radio/dlep_radio_session.c
src-plugins/generic/dlep/router/dlep_router_session.c
src-plugins/generic/nl80211_listener/nl80211_get_interface.c
src-plugins/generic/nl80211_listener/nl80211_get_mpp.c
src-plugins/generic/nl80211_listener/nl80211_get_station_dump.c
src-plugins/generic/nl80211_listener/nl80211_get_survey.c
src-plugins/generic/nl80211_listener/nl80211_get_wiphy.c
src-plugins/nhdp/nhdp/nhdp.c
src-plugins/nhdp/nhdp/nhdp_domain.c
src-plugins/nhdp/nhdp/nhdp_writer.c
src-plugins/olsrv2/olsrv2/olsrv2.c
src-plugins/olsrv2/olsrv2/olsrv2_originator.c
src-plugins/subsystems/oonf_class.c
src-plugins/subsystems/oonf_duplicate_set.c
src-plugins/subsystems/oonf_interface.c
src-plugins/subsystems/oonf_packet_socket.c
src-plugins/subsystems/oonf_stream_socket.c
src-plugins/subsystems/os_generic/os_socket_generic_set_dscp.c
src-plugins/subsystems/os_linux/os_system_linux.c
src-plugins/subsystems/rfc5444/rfc5444_iana.c
src-plugins/subsystems/rfc5444/rfc5444_msg_generator.c
src-plugins/subsystems/rfc5444/rfc5444_writer.c

index bb11ee5..897e512 100644 (file)
@@ -59,7 +59,7 @@ static const char *_isonumber_u64_to_string(char *out,
  * @param out pointer to output buffer
  * @param number number to convert.
  * @param unit unit to be appended at the end, can be NULL
- * @param maxfraction maximum number of fractional digits
+ * @param fraction number of fractional digits
  * @param binary true if conversion should use 1024 as factor,
  *   false for default 1000 conversion factor
  * @param raw true if the whole text conversion should be bypassed
@@ -158,7 +158,7 @@ isonumber_to_s64(int64_t *dst, const char *iso, int fractions, bool binary) {
  * to an unsigned 64bit integer.
  * @param dst pointer to destination variable
  * @param iso pointer to string source
- * @param fractions number of fractional digits, might be zero
+ * @param fraction number of fractional digits, might be zero
  * @param binary true if prefixes should use factor 1024, false if they should
  *   use a factor of 1000
  * @return -1 if an error happened, 0 otherwise
index 28e5ef5..7baebd4 100644 (file)
@@ -652,7 +652,7 @@ cfg_schema_help_acl(
  */
 void
 cfg_schema_help_bitmap256(
-    const struct cfg_schema_entry *entry __attribute((unused)),
+    const struct cfg_schema_entry *entry __attribute__((unused)),
     struct autobuf *out) {
   cfg_help_bitmap256(out, true);
 }
index f8c56e1..814997a 100644 (file)
@@ -319,7 +319,7 @@ oonf_log_updatemask(void)
 }
 
 /**
- * @param pointer to storage object for time string
+ * @param buf buffer to storage object for time string
  * @return pointer to string containing the current walltime
  */
 const char *
@@ -350,6 +350,8 @@ struct timeval now;
  * @param no_header true if time header should not be created
  * @param file filename where the logging macro have been called
  * @param line line number where the logging macro have been called
+ * @param hexptr pointer to binary buffer that should be appended as a hexdump
+ * @param hexlen length of binary buffer to hexdump
  * @param format printf format string for log output plus a variable number of arguments
  */
 void
index 81164d5..4754cc3 100644 (file)
@@ -242,6 +242,7 @@ oonf_plugins_hook(struct oonf_subsystem *plugin) {
 /**
  * Extracts the plugin name from a library name, including optional path,
  * 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
  */
index 590ef7a..a9f0e0d 100644 (file)
@@ -55,8 +55,14 @@ dlep_session_init(void) {
 
 /**
  * Initialize a session, will hook in the base extension
- * @param session
- * @return
+ * @param session session to initialize
+ * @param l2_ifname name of layer2 interface for dlep session
+ * @param l2_origin layer2 db origin id for session
+ * @param out output buffer for session
+ * @param radio true if this is a radio session,
+ *   false for a router session
+ * @param log_source logging source for session
+ * @return -1 if an error happened, 0 otherwise
  */
 int
 dlep_session_add(struct dlep_session *session, const char *l2_ifname,
index 4571da8..5a7d389 100644 (file)
@@ -99,7 +99,7 @@ dlep_radio_session_initialize_tcp_callbacks(
 
 /**
  * Remove existing dlep radio session
- * @param session dlep radio session
+ * @param radio_session dlep radio session
  */
 void
 dlep_radio_remove_session(struct dlep_radio_session *radio_session) {
index ae34664..3ec2fa0 100644 (file)
@@ -202,7 +202,7 @@ dlep_router_add_session(struct dlep_router_if *interf,
 
 /**
  * Remove existing dlep router session
- * @param session dlep router session
+ * @param router_session dlep router session
  */
 void
 dlep_router_remove_session(struct dlep_router_session *router_session) {
index 116742a..e106e21 100644 (file)
@@ -85,8 +85,10 @@ static uint64_t _get_bandwidth(uint32_t width);
 
 /**
  * Send a netlink message to get the nl80211 interface information
+ * @param nl pointer to netlink handler
+ * @param nl_msg pointer to netlink message
+ * @param hdr pointer to generic netlink header
  * @param interf nl80211 listener interface
- * @param nl80211_id generic netlink id for nl80211
  */
 void
 nl80211_send_get_interface(struct os_system_netlink *nl,
index 35bdaef..484fb46 100644 (file)
 
 /**
  * Send a netlink message to get the nl80211 mesh proxy path table
+ * @param nl pointer to netlink handler
+ * @param nl_msg pointer to netlink message
+ * @param hdr pointer to generic netlink header
  * @param interf nl80211 listener interface
- * @param nl80211_id generic netlink id for nl80211
  */
 void
 nl80211_send_get_mpp(struct os_system_netlink *nl, struct nlmsghdr *nl_msg,
index d88f5fd..b54b04b 100644 (file)
@@ -89,8 +89,10 @@ static int64_t _get_bitrate(struct nlattr *bitrate_attr);
 
 /**
  * Send a netlink message to get the nl80211 station dump
+ * @param nl pointer to netlink handler
+ * @param nl_msg pointer to netlink message
+ * @param hdr pointer to generic netlink header
  * @param interf nl80211 listener interface
- * @param nl80211_id generic netlink id for nl80211
  */
 void
 nl80211_send_get_station_dump(struct os_system_netlink *nl,
index 2f0a868..972f3c2 100644 (file)
 #include "nl80211_listener/nl80211_listener.h"
 #include "nl80211_listener/nl80211_get_survey.h"
 
+/**
+ * Send a netlink message to get the nl80211 survey dump
+ * @param nl pointer to netlink handler
+ * @param nl_msg pointer to netlink message
+ * @param hdr pointer to generic netlink header
+ * @param interf nl80211 listener interface
+ */
 void
 nl80211_send_get_survey(struct os_system_netlink *nl, struct nlmsghdr *nl_msg,
     struct genlmsghdr *hdr, struct nl80211_if *interf) {
@@ -94,6 +101,11 @@ nl80211_send_get_survey(struct os_system_netlink *nl, struct nlmsghdr *nl_msg,
       &if_index, sizeof(if_index));
 }
 
+/**
+ * Process NL80211_CMD_NEW_SURVEY_RESULTS message
+ * @param interf nl80211 listener interface
+ * @param hdr pointer to netlink message header
+ */
 void
 nl80211_process_get_survey_result(struct nl80211_if *interf, struct nlmsghdr *hdr) {
   struct genlmsghdr *gnlh;
index ae33bca..60ee110 100644 (file)
@@ -152,7 +152,9 @@ static struct rate_info _mcs_table_80211n_40[77] = {
 
 /**
  * Send a netlink message to get the nl80211 physical capabilities
- * @param nl80211_id generic netlink id for nl80211
+ * @param nl pointer to netlink handler
+ * @param nl_msg pointer to netlink message
+ * @param hdr pointer to generic netlink header
  * @param interf nl80211 listener interface
  */
 void
index 52f35d5..1b1025f 100644 (file)
@@ -283,9 +283,9 @@ nhdp_get_originator(int af_type) {
 /**
  * default implementation for rfc5444 flooding target selection to
  * handle dualstack correctly.
- * @param rfc5444_writer rfc5444 protocol to flood messages
+ * @param writer rfc5444 protocol to flood messages
  * @param rfc5444_target rfc5444 target to flood message
- * @param custom pointer for message flooding
+ * @param ptr custom pointer for message flooding callback
  * @return true if message should be flooded
  */
 bool
@@ -300,13 +300,13 @@ nhdp_flooding_selector(struct rfc5444_writer *writer __attribute__((unused)),
  * @param rfc5444_target rfc5444 target to flood message to
  * @param context reader context of the message to be forwarded
  * @param msg pointer to message buffer
- * @param length of message buffer
+ * @param len length of message buffer
  * @return true if target corresponds to selection
  */
 bool
 nhdp_forwarding_selector(struct rfc5444_writer_target *rfc5444_target,
     struct rfc5444_reader_tlvblock_context *context __attribute__((unused)),
-    const uint8_t *msg __attribute((unused)), size_t len __attribute((unused))) {
+    const uint8_t *msg __attribute__((unused)), size_t len __attribute__((unused))) {
   return _forwarding_selector(rfc5444_target);
 }
 
index 4f8932e..15e2589 100644 (file)
@@ -430,7 +430,7 @@ nhdp_domain_process_metric_linktlv(struct nhdp_domain *domain,
  * Process an in linkmetric tlv for a nhdp twohop neighbor
  * @param domain pointer to NHDP domain
  * @param l2hop pointer to nhdp twohop neighbor
- * @param tlvvalue value of metric tlv
+ * @param value value of metric tlv
  */
 void
 nhdp_domain_process_metric_2hoptlv(struct nhdp_domain *domain,
@@ -581,8 +581,8 @@ nhdp_domain_process_mprtypes_tlv(
  * Process an in MPR tlv for a NHDP link
  * @param mprtypes list of extenstions for MPR
  * @param mprtypes_size length of mprtypes array
- * @param lnk NHDP link
- * @param tlv MPR tlv
+ * @param neigh NHDP neighbor
+ * @param tlv MPR tlv context
  */
 void
 nhdp_domain_process_mpr_tlv(uint8_t *mprtypes, size_t mprtypes_size,
@@ -631,11 +631,9 @@ nhdp_domain_process_mpr_tlv(uint8_t *mprtypes, size_t mprtypes_size,
  * Process an in Willingness tlv and put values into
  * temporary storage in MPR handler object. Call
  * nhdp_domain_store_willingness to permanently store them later.
- * @param neighbor neighbor we received a willingness TLV from
  * @param mprtypes list of extenstions for MPR
  * @param mprtypes_size length of mprtypes array
- * @param tlvvalue willingness array to parse
- * @param tlvsize length of willingness array
+ * @param tlv Willingness tlv context
  */
 void
 nhdp_domain_process_willingness_tlv(
@@ -830,7 +828,7 @@ nhdp_domain_set_flooding_mpr(const char *mpr_name, uint8_t willingness) {
 /**
  * Sets the incoming metric of a link. This is the only function external
  * code should use to commit the calculated metric values to the nhdp db.
- * @param domain NHDP domain
+ * @param metric NHDP domain metric
  * @param lnk NHDP link
  * @param metric_in incoming metric value for NHDP link
  * @return true if metric changed, false otherwise
index 15d8ae1..51021cd 100644 (file)
@@ -143,7 +143,7 @@ nhdp_writer_cleanup(void) {
 /**
  * Send a NHDP Hello through the specified interface. This might result
  * in both an IPv4 and IPv6 message
- * @param interf NHDP interface
+ * @param ninterf NHDP interface
  */
 void
 nhdp_writer_send_hello(struct nhdp_interface *ninterf) {
index a96f666..a60d1b1 100644 (file)
@@ -364,9 +364,10 @@ olsrv2_mpr_shall_process(
 /**
  * default implementation for rfc5444 forwarding handling according
  * to MPR settings.
- * @param context
- * @param vtime
- * @return
+ * @param context RFC5444 reader context
+ * @param source_address source address of RFC5444 message
+ * @param vtime validity time of message information
+ * @return true if message was forwarded, false otherwise
  */
 bool
 olsrv2_mpr_shall_forwarding(struct rfc5444_reader_tlvblock_context *context,
index 4d6c2a7..f7fcca3 100644 (file)
@@ -108,7 +108,7 @@ olsrv2_originator_cleanup(void) {
 }
 
 /**
- * @param address type of originator
+ * @param af_type address type of originator
  * @return current originator address of specified type
  */
 const struct netaddr *
index 4a1a69e..e9732c2 100644 (file)
@@ -336,8 +336,8 @@ oonf_class_extension_add(struct oonf_class_extension *ext) {
 }
 
 /**
- * Remove listener from class
- * @param l pointer to listener
+ * Remove extension from class
+ * @param ext pointer to class extension
  */
 void
 oonf_class_extension_remove(struct oonf_class_extension *ext) {
index 17f27a6..35e1a32 100644 (file)
@@ -127,7 +127,8 @@ _cleanup(void) {
 
 /**
  * Initialize a new duplicate set
- * @param set pointer to duplicate set;
+ * @param set pointer to duplicate set
+ * @param type type of duplicate set
  */
 void
 oonf_duplicate_set_add(struct oonf_duplicate_set *set, enum oonf_dupset_type type) {
index 8951976..695a3fa 100644 (file)
@@ -211,8 +211,8 @@ oonf_interface_remove_listener(
 /**
  * Trigger a potential change in the interface settings. Normally
  * called by os_system code
- * @param name interface name
- * @param down true if interface is going down
+ * @param if_index interface index
+ * @param down true if interface is going down, false otherwise
  */
 void
 oonf_interface_trigger_ifindex(unsigned if_index, bool down) {
@@ -259,7 +259,7 @@ oonf_interface_trigger(struct os_interface *interf) {
 /**
  * Trigger the interface change handler after a short waiting period
  * to accumulate multiple change events.
- * @param interf pointer to olsr interface
+ * @param listener pointer to interface change handler
  */
 void
 oonf_interface_trigger_handler(struct oonf_interface_listener *listener) {
@@ -377,10 +377,11 @@ oonf_interface_get_prefix_from_dst(
 
 /**
  * Calculate the IP address a socket should bind to
+ * @param af_type address family for result
  * @param filter filter for IP address to bind on
  * @param ifdata interface to bind to socket on, NULL if not
  *   bound to an interface.
- * @return 0 if an IP was calculated, -1 otherwise
+ * @return pointer to address, NULL if no valid address was found
  */
 const struct netaddr *
 oonf_interface_get_bindaddress(int af_type,
index ffc442c..9abc3a5 100644 (file)
@@ -146,7 +146,7 @@ oonf_packet_add(struct oonf_packet_socket *pktsocket,
 /**
  * Add a new raw packet socket handler
  * @param pktsocket pointer to an initialized packet socket struct
- * @param int IP protocol number
+ * @param protocol IP protocol number
  * @param local pointer local IP address of packet socket
  * @param interf pointer to interface to bind socket on, NULL
  *   if socket should not be bound to interface
index c31e035..8776b02 100644 (file)
@@ -324,8 +324,6 @@ oonf_stream_set_timeout(struct oonf_stream_session *con, uint64_t timeout) {
 /**
  * Close a TCP stream session
  * @param session pointer to stream session
- * @param force true if the session should be closed instantly,
- *   false if all data in queue should still be sent
  */
 void
 oonf_stream_close(struct oonf_stream_session *session) {
index b4e748c..a586b95 100644 (file)
@@ -51,6 +51,7 @@
  * Sets the DSCP value for outgoing packets on a socket
  * @param sock socket file descriptor
  * @param dscp dscp value
+ * @param ipv6 true if IPv6 dscp should be set, false otherwise
  * @return -1 if an error happened, 0 otherwise
  */
 int
index 5cde8e2..5a21092 100644 (file)
@@ -445,20 +445,21 @@ os_system_netlink_drop_mc(struct os_system_netlink *nl,
 
 /**
  * Add an attribute to a netlink message
- * @param n pointer to netlink header
+ * @param nl pinter to os netlink handler
+ * @param nlmsg pointer to netlink header
  * @param type type of netlink attribute
  * @param data pointer to data of netlink attribute
  * @param len length of data of netlink attribute
  * @return -1 if netlink message got too large, 0 otherwise
  */
 int
-os_system_netlink_addreq(struct os_system_netlink *nl __attribute__((unused)),
-    struct nlmsghdr *n, int type, const void *data, int len) {
+os_system_netlink_addreq(struct os_system_netlink *nl,
+    struct nlmsghdr *nlmsg, int type, const void *data, int len) {
   struct nlattr *nl_attr;
   size_t aligned_msg_len, aligned_attr_len;
 
   /* calculate aligned length of message and new attribute */
-  aligned_msg_len = NLMSG_ALIGN(n->nlmsg_len);
+  aligned_msg_len = NLMSG_ALIGN(nlmsg->nlmsg_len);
   aligned_attr_len = NLA_HDRLEN + len;
 
   if (aligned_msg_len + aligned_attr_len > UIO_MAXIOV) {
@@ -466,12 +467,12 @@ os_system_netlink_addreq(struct os_system_netlink *nl __attribute__((unused)),
     return -1;
   }
 
-  nl_attr = (struct nlattr *) ((void*)((char *)n + aligned_msg_len));
+  nl_attr = (struct nlattr *) ((void*)((char *)nlmsg + aligned_msg_len));
   nl_attr->nla_type = type;
   nl_attr->nla_len = aligned_attr_len;
 
   /* fix length of netlink message */
-  n->nlmsg_len = aligned_msg_len + aligned_attr_len;
+  nlmsg->nlmsg_len = aligned_msg_len + aligned_attr_len;
 
   if (len) {
     memcpy((char *)nl_attr + NLA_HDRLEN, data, len);
index c993063..4214b4d 100644 (file)
@@ -77,7 +77,7 @@ rfc7182_get_hash_name(enum rfc7182_icv_hash hash) {
 
 /**
  * Give name of rfc 7182 crypto
- * @param crypto crypto-id
+ * @param crypt crypto-id
  * @return name of crypto
  */
 const char *
index 01d3686..c6ee708 100644 (file)
@@ -422,6 +422,7 @@ bool rfc5444_writer_alltargets_selector(struct rfc5444_writer *writer __attribut
  * to be compatible with the readers forward_message callback.
  *
  * @param writer pointer to writer context
+ * @param context RFC5444 reader context of message
  * @param msg pointer to message to be forwarded
  * @param len number of bytes of message
  * @return RFC5444_OKAY if the message was put into the writer buffer,
index ea67a2c..98b8630 100644 (file)
@@ -223,7 +223,7 @@ rfc5444_writer_add_addrtlv(struct rfc5444_writer *writer, struct rfc5444_writer_
  *
  * @param writer pointer to writer context
  * @param msg pointer to message object
- * @param address pointer network address
+ * @param naddr pointer network address
  * @param mandatory true if address is mandatory for all fragments of message
  * @return pointer to address object, NULL if an error happened
  */
@@ -388,7 +388,7 @@ rfc5444_writer_unregister_content_provider(
  *
  * @param writer pointer to writer context
  * @param msgid message type
- * @param target_specific true if an unique message must be created for each
+ * @param if_specific true if an unique message must be created for each
  *   interface
  * @return message object, NULL if an error happened
  */