diff options
author | Evan Huus <eapache@gmail.com> | 2013-04-26 18:28:21 +0000 |
---|---|---|
committer | Evan Huus <eapache@gmail.com> | 2013-04-26 18:28:21 +0000 |
commit | 63ef04ec84bc7bee9008be686e2e362058229643 (patch) | |
tree | 9acdd76172b3e37a08f887543cd0ee01e9a24419 /epan | |
parent | 098997e5fb7e152bd777941e1a7a3f2ec3b8759b (diff) |
Fix a whole bunch of doxygen warnings, mostly typos or renamed parameters.
svn path=/trunk/; revision=49053
Diffstat (limited to 'epan')
-rw-r--r-- | epan/addr_resolv.h | 2 | ||||
-rw-r--r-- | epan/expert.h | 2 | ||||
-rw-r--r-- | epan/packet.h | 2 | ||||
-rw-r--r-- | epan/prefs.h | 3 | ||||
-rw-r--r-- | epan/proto.h | 4 | ||||
-rw-r--r-- | epan/strutil.h | 4 |
6 files changed, 8 insertions, 9 deletions
diff --git a/epan/addr_resolv.h b/epan/addr_resolv.h index 4b19ecfded..2eadaed32f 100644 --- a/epan/addr_resolv.h +++ b/epan/addr_resolv.h @@ -221,7 +221,7 @@ WS_DLL_PUBLIC void add_ipv6_name(const struct e_in6_addr *addr, const gchar *nam * The file can be added before host_name_lookup_init() is called and * will be re-read each time host_name_lookup_init() is called. * - * @param hostspath Absolute path to the hosts file. + * @param hosts_file Absolute path to the hosts file. * * @return TRUE if the hosts file can be read. */ diff --git a/epan/expert.h b/epan/expert.h index 835fc0049d..66a9b92a0a 100644 --- a/epan/expert.h +++ b/epan/expert.h @@ -101,7 +101,7 @@ expert_add_info_format(packet_info *pinfo, proto_item *pi, int group, /** Add an expert info about not dissected "item" Add an expert info tree to a not dissected protocol item. - @patam tvb The tvb associated with the item. + @param tvb The tvb associated with the item. @param pinfo Packet info of the currently processed packet. May be NULL. @param tree Tree to add the item to @param offset Offset in tvb diff --git a/epan/packet.h b/epan/packet.h index fca61710fe..dad94eb9bc 100644 --- a/epan/packet.h +++ b/epan/packet.h @@ -294,7 +294,7 @@ WS_DLL_PUBLIC void heur_dissector_delete(const char *name, heur_dissector_t diss * @param name the name of the "parent" protocol, e.g. "tcp" * @param dissector the sub-dissector to be disabled/enabled * @param proto the protocol id of the sub-dissector - * @param TRUE/FALSE to enable/disable the sub-dissector + * @param enabled TRUE/FALSE to enable/disable the sub-dissector */ extern void heur_dissector_set_enabled(const char *name, heur_dissector_t dissector, const int proto, const gboolean enabled); diff --git a/epan/prefs.h b/epan/prefs.h index 174a081b5f..4355d20997 100644 --- a/epan/prefs.h +++ b/epan/prefs.h @@ -509,8 +509,7 @@ char *prefs_pref_type_description(pref_t *pref); /** Fetch a string representation of the preference. * * @param pref A preference. - * @param default_val Return the default value if TRUE or the current value - * if FALSE. + * @param source Which value of the preference to return, see pref_source_t. * * @return A string representation of the preference. Must be g_free()d. */ diff --git a/epan/proto.h b/epan/proto.h index adf5ffbc82..31a8748fd6 100644 --- a/epan/proto.h +++ b/epan/proto.h @@ -1982,7 +1982,7 @@ proto_tree_add_bits_item(proto_tree *tree, const int hf_index, tvbuff_t *tvb, co @param hf_index field index. Fields for use with this function should have bitmask==0. @param tvb the tv buffer of the current data @param bit_offset of the first crumb in tvb expressed in bits - @param pointer to crumb_spec array + @param crumb_spec pointer to crumb_spec array @param return_value if a pointer is passed here the value is returned. @return the newly created item */ extern proto_item * @@ -2002,7 +2002,7 @@ proto_tree_add_split_bits_item_ret_val(proto_tree *tree, const int hf_index, tvb @param hf_index field index. Fields for use with this function should have bitmask==0. @param tvb the tv buffer of the current data @param bit_offset of the first crumb in tvb expressed in bits - @param pointer to crumb_spec array + @param crumb_spec pointer to crumb_spec array @param index into the crumb_spec array for this crumb */ void proto_tree_add_split_bits_crumb(proto_tree *tree, const int hf_index, tvbuff_t *tvb, const guint bit_offset, diff --git a/epan/strutil.h b/epan/strutil.h index a3f54a7054..e68032c056 100644 --- a/epan/strutil.h +++ b/epan/strutil.h @@ -263,7 +263,7 @@ void IA5_7BIT_decode(unsigned char * dest, const unsigned char* src, int len); /** Copy a string, escaping the 'chr' characters in it * * @param str The string to be copied - * @param char The character to be escaped + * @param chr The character to be escaped * @return A copy of the string with every original 'chr' being * transformed into double 'chr'. */ @@ -273,7 +273,7 @@ gchar* ws_strdup_escape_char (const gchar *str, const gchar chr); /** Copy a string, unescaping the 'chr' characters in it * * @param str The string to be copied - * @param char The character to be escaped + * @param chr The character to be escaped * @return A copy of the string with every occurrence of double 'chr' in * the original string being copied as a single 'chr'. */ |