Fixes for doxygen comments
authorHenning Rogge <henning.rogge@fkie.fraunhofer.de>
Thu, 22 Mar 2018 08:26:21 +0000 (09:26 +0100)
committerHenning Rogge <henning.rogge@fkie.fraunhofer.de>
Thu, 22 Mar 2018 08:26:21 +0000 (09:26 +0100)
src-api/config/cfg.c
src-api/config/cfg_help.c
src-api/config/cfg_tobin.c
src-api/config/cfg_validate.c
src-plugins/nhdp/nhdp/nhdp_domain.c
src-plugins/subsystems/oonf_layer2.c
src-plugins/subsystems/oonf_layer2.h
src-plugins/subsystems/os_linux/os_fd_linux.h

index be4dcf3..e84b78c 100644 (file)
@@ -180,7 +180,7 @@ cfg_get_choice_array_value(size_t idx, const void *ptr) {
  * Looks up the index of a string within a string array
  * @param key pointer to string to be looked up in the array
  * @param callback pointer to the callback that returns choice options
- * @param choice_count number of choices
+ * @param choices_count number of choices
  * @param ptr (optional) pointer for choice callback
  * @return index of the string inside the array, -1 if not found
  */
index 71543ff..88af63f 100644 (file)
@@ -85,8 +85,9 @@ cfg_help_printable(struct autobuf *out, size_t len) {
  * Produce help text for a choice of multiple constants
  * @param out output buffer
  * @param preamble true if preamble should be printed
- * @param choices function pointer to retriev text choices
- * @param choice_count number of choices
+ * @param callback callback function that provides the choices for configuration
+ * @param choice_count number of strings in list
+ * @param ptr customization pointer for callback
  */
 void
 cfg_help_choice(struct autobuf *out, bool preamble, const char *(*callback)(size_t idx, const void *ptr),
index c5e13e9..e97053c 100644 (file)
@@ -74,8 +74,9 @@ cfg_tobin_strarray(void *reference, size_t bin_size, const struct const_strarray
  * @param reference pointer to binary output buffer.
  * @param bin_size size of reference memory
  * @param value pointer to value of configuration entry.
- * @param choices array of strings to choose from
- * @param choice_count number of strings to choose from
+ * @param callback callback function providing choices for conversion
+ * @param choices_count number of strings in list
+ * @param ptr customization pointer for callback
  * @return 0 if conversion succeeded, -1 otherwise.
  */
 int
@@ -267,10 +268,10 @@ cfg_tobin_stringlist(void *reference, size_t bin_size, const struct const_strarr
  * Binary converter for list of space separated tokens.
  * See CFG_MAP_STRINGLIST() macro in cfg_schema.h
  * @param reference pointer to binary output buffer.
- * @param bin_size size of reference memory
  * @param value pointer to value of configuration entry.
  * @param entries pointer to array of configuration entries
  * @param entry_count number of configuration entries
+ * @param custom customizer parameters for token conversion
  * @return 0 if conversion succeeded, -1 otherwise.
  */
 int
index 9650dc8..b855223 100644 (file)
@@ -110,8 +110,9 @@ cfg_validate_strlen(
  * @param section_name name of configuration section
  * @param entry_name name of configuration entry
  * @param value value that needs to be validated
- * @param choices pointer to list of strings
+ * @param callback callback function to get choices from
  * @param choices_count number of strings in list
+ * @param ptr customization pointer for callback
  * @return 0 if value is valid, -1 otherwise
  */
 int
index 7c6328d..0840cc6 100644 (file)
@@ -567,7 +567,6 @@ nhdp_domain_recalculate_mpr(void) {
  * @param domain NHDP domain
  * @param neigh neighbor that triggered the recalculation,
  *   NULL for unspecified neighbor
- * @return
  */
 void
 nhdp_domain_delayed_mpr_recalculation(struct nhdp_domain *domain, struct nhdp_neighbor *neigh __attribute__((unused))) {
@@ -625,7 +624,7 @@ nhdp_domain_process_mprtypes_tlv(uint8_t *mprtypes, size_t mprtypes_size, struct
  * Process an in MPR tlv for a NHDP link
  * @param mprtypes list of extensions for MPR
  * @param mprtypes_size length of mprtypes array
- * @param neigh NHDP neighbor
+ * @param lnk NHDP link
  * @param tlv MPR tlv context
  */
 void
@@ -736,7 +735,7 @@ nhdp_domain_process_willingness_tlv(
 /**
  * Stores the willingness data processed by
  * nhdp_domain_process_willingness_tlv() into a neighbor object
- * @param neigh NHDP neighbor
+ * @param lnk NHDP link
  */
 void
 nhdp_domain_store_willingness(struct nhdp_link *lnk) {
@@ -781,7 +780,7 @@ nhdp_domain_encode_mprtypes_tlvvalue(uint8_t *mprtypes, size_t mprtypes_size) {
  *
  * @param tlvvalue destination for value of MPR tlv
  * @param tlvsize length of tlv value
- * @param neigh pointer to NHDP neighbor for MPR tlv
+ * @param lnk pointer to NHDP link for MPR tlv
  * @return length of tlvvalue, 0 if an error happened
  */
 size_t
@@ -993,7 +992,6 @@ _recalculate_routing_mpr_set(struct nhdp_domain *domain) {
  * and check for two-hop outgoing link metric changes
  * @param domain NHDP domain
  * @param neigh NHDP neighbor
- * @param neighdata NHDP neighbor domaindata
  * @return true neighbor metric or the two-hop link metrics changed
  */
 static bool
index 635d116..6c8adf4 100644 (file)
@@ -328,7 +328,8 @@ oonf_layer2_data_set(struct oonf_layer2_data *l2data, const struct oonf_layer2_o
  * Compare two layer2 data objects
  * @param left left parameter for comparator
  * @param right right parameter for comparator
- * @param cmp comparator
+ * @param comparator comparator type
+ * @param data_type data type for comparison
  * @return comparator result, false if not valid
  *   (e.g. comparing different types of data)
  */
@@ -843,7 +844,8 @@ oonf_layer2_neigh_relabel(struct oonf_layer2_neigh *l2neigh, const struct oonf_l
 /**
  * Add an IP address or prefix to a layer-2 interface. This represents
  * an address of the local radio or modem.
- * @param l2net layer-2 network object
+ * @param l2neigh layer-2 neighbor object
+ * @param origin layer2 data origin
  * @param ip ip address or prefix
  * @return layer2 ip address object, NULL if out of memory
  */
index 9ad81f8..ac5562c 100644 (file)
@@ -564,7 +564,7 @@ oonf_layer2_net_get(const char *ifname) {
 /**
  * Get a layer-2 local peer ip address object from the database
  * @param l2net layer-2 network/interface object
- * @param ip ip address of local radio/modem
+ * @param addr ip address of local radio/modem
  * @return layer-2 ip address object, NULL if not found
  */
 static INLINE struct oonf_layer2_peer_address *
@@ -576,7 +576,7 @@ oonf_layer2_net_get_local_ip(const struct oonf_layer2_net *l2net, const struct n
 /**
  * Get a layer-2 ip address object from the database
  * @param l2net layer-2 network object
- * @param ip ip address of remote router
+ * @param addr ip address of remote router
  * @return layer-2 ip address object, NULL if not found
  */
 static INLINE struct oonf_layer2_neighbor_address *
@@ -600,7 +600,7 @@ oonf_layer2_neigh_get(const struct oonf_layer2_net *l2net, const struct netaddr
 /**
  * Get a layer-2 ip address object from the database
  * @param l2neigh layer-2 neighbor object
- * @param ip ip address of remote router
+ * @param addr ip address of remote router
  * @return layer-2 ip address object, NULL if not found
  */
 static INLINE struct oonf_layer2_neighbor_address *
index 2aeba98..9d597a1 100644 (file)
@@ -490,7 +490,7 @@ os_fd_get_socket_error(struct os_fd *sockfd, int *value) {
 
 /**
  * Sends data to an UDP socket.
- * @param sockfd filedescriptor of UDP socket
+ * @param sock 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