Fix (-W)documentation error found by Clang

packet-eigrp.c:633:10: error: unrecognized parameter passing direction, valid
      directions are '[in]', '[out]' and '[in,out]' [-Werror,-Wdocumentation]
 * @param[in|out] tree  detail dissection result
         ^~~~~~~~
packet-eigrp.c:638:5: error: '@return' command used in a comment that is
      attached to a function returning void [-Werror,-Wdocumentation]
 * @return void
   ~^~~~~~~~~~~
packet-eigrp.c:691:10: error: unrecognized parameter passing direction, valid
      directions are '[in]', '[out]' and '[in,out]' [-Werror,-Wdocumentation]
 * @param[in|out] tree  detail dissection result
         ^~~~~~~~
packet-eigrp.c:696:5: error: '@return' command used in a comment that is
      attached to a function returning void [-Werror,-Wdocumentation]
 * @return void
   ~^~~~~~~~~~~
packet-eigrp.c:765:10: error: unrecognized parameter passing direction, valid
      directions are '[in]', '[out]' and '[in,out]' [-Werror,-Wdocumentation]
 * @param[in|out] tree  detail dissection result
         ^~~~~~~~
packet-eigrp.c:769:5: error: '@return' command used in a comment that is
      attached to a function returning void [-Werror,-Wdocumentation]
 * @return void
   ~^~~~~~~~~~~
packet-eigrp.c:814:10: error: unrecognized parameter passing direction, valid
      directions are '[in]', '[out]' and '[in,out]' [-Werror,-Wdocumentation]
 * @param[in|out] tree  detail dissection result
         ^~~~~~~~
packet-eigrp.c:818:5: error: '@return' command used in a comment that is
      attached to a function returning void [-Werror,-Wdocumentation]
 * @return void
   ~^~~~~~~~~~~
packet-eigrp.c:853:10: error: unrecognized parameter passing direction, valid
      directions are '[in]', '[out]' and '[in,out]' [-Werror,-Wdocumentation]
 * @param[in|out] tree  detail dissection result
         ^~~~~~~~
packet-eigrp.c:857:5: error: '@return' command used in a comment that is
      attached to a function returning void [-Werror,-Wdocumentation]
 * @return void
   ~^~~~~~~~~~~
packet-eigrp.c:878:10: error: unrecognized parameter passing direction, valid
      directions are '[in]', '[out]' and '[in,out]' [-Werror,-Wdocumentation]
 * @param[in|out] tree  detail dissection result
         ^~~~~~~~
packet-eigrp.c:882:19: error: empty paragraph passed to '@param' command
      [-Werror,-Wdocumentation]
 * @param[out] None
   ~~~~~~~~~~~~~~~^
packet-eigrp.c:884:5: error: '@return' command used in a comment that is
      attached to a function returning void [-Werror,-Wdocumentation]
 * @return void
   ~^~~~~~~~~~~
packet-eigrp.c:880:15: error: parameter 'pinfo' not found in the function
      declaration [-Werror,-Wdocumentation]
 * @param[in] pinfo     general data about the protocol
              ^~~~~
packet-eigrp.c:881:15: error: parameter 'ti' not found in the function
      declaration [-Werror,-Wdocumentation]
 * @param[in] ti        protocol item
              ^~
packet-eigrp.c:882:16: error: parameter 'None' not found in the function
      declaration [-Werror,-Wdocumentation]
 * @param[out] None
               ^~~~
packet-eigrp.c:902:19: error: empty paragraph passed to '@param' command
      [-Werror,-Wdocumentation]
 * @param[out] None
   ~~~~~~~~~~~~~~~^
packet-eigrp.c:904:5: error: '@return' command used in a comment that is
      attached to a function returning void [-Werror,-Wdocumentation]
 * @return void
   ~^~~~~~~~~~~
packet-eigrp.c:902:16: error: parameter 'None' not found in the function
      declaration [-Werror,-Wdocumentation]
 * @param[out] None
               ^~~~
packet-eigrp.c:1712:15: error: parameter 'pinfo' not found in the function
      declaration [-Werror,-Wdocumentation]
 * @param[in] pinfo     general data about the protocol
              ^~~~~
packet-eigrp.c:1712:15: note: did you mean 'ti'?
 * @param[in] pinfo     general data about the protocol
              ^~~~~
              ti
packet-eigrp.c:2585:18: error: empty paragraph passed to '@param' command
      [-Werror,-Wdocumentation]
 * @param[in] void
   ~~~~~~~~~~~~~~^
packet-eigrp.c:2585:15: error: parameter 'void' not found in the function
      declaration [-Werror,-Wdocumentation]
 * @param[in] void
              ^~~~
packet-eigrp.c:3324:18: error: empty paragraph passed to '@param' command
      [-Werror,-Wdocumentation]
 * @param[in] void
   ~~~~~~~~~~~~~~^
packet-eigrp.c:3324:15: error: parameter 'void' not found in the function
      declaration [-Werror,-Wdocumentation]
 * @param[in] void
              ^~~~

svn path=/trunk/; revision=51266

1 files changed, 28 insertions, 67 deletions

diff --git a/epan/dissectors/packet-eigrp.c b/epan/dissectors/packet-eigrp.c
index a1c0d599e9..c8756514f6 100644
--- a/epan/dissectors/packet-eigrp.c
+++ b/epan/dissectors/packet-eigrp.c
@@ -630,13 +630,11 @@ static const value_string eigrp_saf_srv2string[] = {
  *@fn void dissect_eigrp_parameter (proto_tree *tree, tvbuff_t *tvb, packet_info *pinfo,
  *
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] pinfo     general data about the protocol
  * @param[in] ti        protocol item
  *
- * @return void
- *
  * @par
  * Dissect the Parameter TLV, which is used to convey metric weights and the
  * hold time.
@@ -688,13 +686,11 @@ dissect_eigrp_parameter (proto_tree *tree, tvbuff_t *tvb, packet_info *pinfo,
  *@fn void dissect_eigrp_auth_tlv (proto_tree *tree, tvbuff_t *tvb,
  *                                 packet_info *pinfo, proto_item *ti)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] pinfo     general data about the protocol
  * @param[in] ti        protocol item
  *
- * @return void
- *
  * @par
  * Dissect the Authentication TLV and display digest. Currently MD5 and SHA256
  * HMAC is supported.  For SHA256, a "secret key" with the HMAC-SHA-256
@@ -762,12 +758,10 @@ dissect_eigrp_auth_tlv (proto_tree *tree, tvbuff_t *tvb,
  *@fn void dissect_eigrp_seq_tlv (proto_tree *tree, tvbuff_t *tvb,
  *                                packet_info *pinfo)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] pinfo     general data about the protocol
  *
- * @return void
- *
  * @par
  * Dissect the Sequence TLV which consist of the address of peers that must
  * not receive the next multicast packet transmitted.
@@ -811,12 +805,10 @@ dissect_eigrp_seq_tlv (proto_tree *tree, tvbuff_t *tvb,
  *@fn void dissect_eigrp_sw_version (tvbuff_t *tvb, proto_tree *tree,
  *                                   proto_item *ti)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] ti        protocol item
  *
- * @return void
- *
  * @par
  * Dissect Software Version TLV.  The older versions of EIGRP sent the IOS
  * version along with the TLV Version.   When EIGRP "plugins" were created,
@@ -850,12 +842,10 @@ dissect_eigrp_sw_version (tvbuff_t *tvb, proto_tree *tree,
  *@fn void dissect_eigrp_next_mcast_seq (tvbuff_t *tvb, proto_tree *tree,
  *                                      proto_item *ti)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] ti        protocol item
  *
- * @return void
- *
  * @par
  * Dissect Next Multicast Sequence TLV, which is part of the Hello with a
  * Sequence TLV;  this gives a two-way binding between the packets and plugs a
@@ -875,13 +865,8 @@ dissect_eigrp_next_mcast_seq (tvbuff_t *tvb, proto_tree *tree,
  *@fn void dissect_eigrp_peer_stubinfo (tvbuff_t *tvb, proto_tree *tree)
  *
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
- * @param[in] pinfo     general data about the protocol
- * @param[in] ti        protocol item
- * @param[out] None
- *
- * @return void
  *
  * @par
  * Dissect the PEER STUB TLV which contains the route types which the Peer will
@@ -899,9 +884,6 @@ dissect_eigrp_peer_stubinfo (tvbuff_t *tvb, proto_tree *tree)
  *
  * @param[in] pinfo     general data about the protocol
  * @param[in] ti        protocol item
- * @param[out] None
- *
- * @return void
  *
  * @par
  * Dissect Peer Termination TLV.  This TLV has no parameters and is used to
@@ -916,11 +898,9 @@ dissect_eigrp_peer_termination (packet_info *pinfo, proto_item *ti)
 /**
  *@fn void dissect_eigrp_peer_tidlist (proto_tree *tree, tvbuff_t *tvb)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  *
- * @return void
- *
  * @par
  *  Dissect the Topology Identifier List TLV.  This TLV was introduced as part
  *  of the "MTR (Multi-Topology Routing) Project to support sub topologies
@@ -964,7 +944,7 @@ dissect_eigrp_peer_tidlist (proto_tree *tree, tvbuff_t *tvb)
 /**
  *@fn int dissect_eigrp_extdata_flags (proto_tree *tree, tvbuff_t *tvb, int offset)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] offset    current byte offset in packet being processed
  *
@@ -1006,7 +986,7 @@ dissect_eigrp_extdata_flags (proto_tree *tree, tvbuff_t *tvb, int offset)
 /**
  *@fn int dissect_eigrp_metric_flags (proto_tree *tree, tvbuff_t *tvb, int offset, int limit)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] offset    current byte offset in packet being processed
  * @param[in] limit     maximum number of bytes which can be process
@@ -1056,7 +1036,7 @@ dissect_eigrp_metric_flags (proto_tree *tree, tvbuff_t *tvb, int offset, int lim
  *@fn int dissect_eigrp_ipv4_addr (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *                                 packet_info *pinfo, int offset, int unreachable)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] pinfo     general data about the protocol
  * @param[in] offset    current byte offset in packet being processed
@@ -1111,7 +1091,7 @@ dissect_eigrp_ipv4_addr (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *@fn int dissect_eigrp_ipv6_addr (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *                                 packet_info *pinfo, int offset, int unreachable)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] pinfo     general data about the protocol
  * @param[in] offset    current byte offset in packet being processed
@@ -1171,7 +1151,7 @@ dissect_eigrp_ipv6_addr (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *@fn int dissect_eigrp_ipx_addr (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *                                packet_info *pinfo, int offset, int unreachable)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] pinfo     general data about the protocol
  * @param[in] offset    current byte offset in packet being processed
@@ -1207,7 +1187,7 @@ dissect_eigrp_ipx_addr (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *@fn int dissect_eigrp_service (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *                               packet_info *pinfo, int offset)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] pinfo     general data about the protocol
  * @param[in] ti        protocol item
@@ -1368,7 +1348,7 @@ dissect_eigrp_service (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
 /**
  *@fn int dissect_eigrp_legacy_metric (proto_tree *tree, tvbuff_t *tvb, int offset)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] offset    current byte offset in packet being processed
  *
@@ -1427,7 +1407,7 @@ dissect_eigrp_legacy_metric (proto_tree *tree, tvbuff_t *tvb, int offset)
 /**
  *@fn int dissect_eigrp_ipx_extdata (proto_tree *tree, tvbuff_t *tvb, int offset)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] offset    current byte offset in packet being processed
  *
@@ -1498,7 +1478,7 @@ dissect_eigrp_ipx_extdata (proto_tree *tree, tvbuff_t *tvb, int offset)
 /**
  *@fn int dissect_eigrp_extdata (proto_tree *tree, tvbuff_t *tvb, int offset)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] offset    current byte offset in packet being processed
  *
@@ -1565,7 +1545,7 @@ dissect_eigrp_extdata (proto_tree *tree, tvbuff_t *tvb, int offset)
 /**
  *@fn int dissect_eigrp_nexthop (proto_tree *tree, tvbuff_t *tvb, guint16 afi, int offset)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] afi       IANA address family indicator
  * @param[in] offset    current byte offset in packet being processed
@@ -1619,14 +1599,11 @@ dissect_eigrp_nexthop (proto_tree *tree, tvbuff_t *tvb, guint16 afi, int offset)
  *@fn void dissect_eigrp_general_tlv (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *                                    packet_info *pinfo, guint16 tlv)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] pinfo     general data about the protocol
  * @param[in] ti        protocol item
  * @param[in] tlv       Specific TLV in to be dissected
- * @param[out] None
- *
- * @return void
  *
  * @par
  * General EIGRP parameters carry EIGRP management information and are not
@@ -1673,7 +1650,7 @@ dissect_eigrp_general_tlv (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *@fn int dissect_eigrp_ipv4_tlv (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *                                 packet_info *pinfo, guint16 tlv)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] pinfo     general data about the protocol
  * @param[in] tlv       Specific TLV in to be dissected
@@ -1730,13 +1707,10 @@ dissect_eigrp_ipv4_tlv (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *@fn void dissect_eigrp_atalk_tlv (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *                                  proto_item *ti, guint16 tlv)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
- * @param[in] pinfo     general data about the protocol
  * @param[in] tlv       Specific TLV in to be dissected
  *
- * @return void
- *
  * @par
  * Dissect the legacy AppleTalk route TLV; handles both the internal and external
  * TLV type.  The following represents the format
@@ -1783,13 +1757,11 @@ dissect_eigrp_atalk_tlv (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *@fn void dissect_eigrp_ipv6_tlv (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *                                 packet_info *pinfo, guint16 tlv)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] pinfo     general data about the protocol
  * @param[in] tlv       Specific TLV in to be dissected
  *
- * @return void
- *
  * @par
  * Dissect the Legacy IPv6 route TLV; handles both the internal and external
  * TLV types; This packet format is being deprecated and replaced with the
@@ -1825,7 +1797,7 @@ dissect_eigrp_ipv6_tlv (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *@fn int dissect_eigrp_ipx_tlv (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *                                packet_info *pinfo, guint16 tlv)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] pinfo     general data about the protocol
  * @param[in] tlv       Specific TLV in to be dissected
@@ -1903,7 +1875,7 @@ dissect_eigrp_ipx_tlv (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *@fn void dissect_eigrp_ipv4_tlv (proto_item *ti, proto_tree *tree, tvbuff_t *tvb,
  *                                 packet_info *pinfo, proto_item *ti, guint16 tlv)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] pinfo     general data about the protocol
  * @param[in] ti        protocol item
@@ -2014,7 +1986,7 @@ dissect_eigrp_multi_topology_tlv (proto_item *ti, proto_tree *tree, tvbuff_t *tv
 /**
  *@fn int dissect_eigrp_metric_comm (proto_tree *tree, tvbuff_t *tvb, int offset, int limit)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] offset    current byte offset in packet being processed
  * @param[in] limit     maximum number of bytes which can be process
@@ -2128,7 +2100,7 @@ dissect_eigrp_metric_comm (proto_tree *tree, tvbuff_t *tvb, int offset, int limi
  *@fn int dissect_eigrp_wide_metric_attr (proto_tree *tree, tvbuff_t *tvb,
  *                                        int offset, int limit)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] offset    current byte offset in packet being processed
  * @param[in] limit     maximum number of words which should be process
@@ -2220,7 +2192,7 @@ dissect_eigrp_wide_metric_attr (proto_tree *tree, tvbuff_t *tvb,
 /**
  *@fn int dissect_eigrp_wide_metric (proto_tree *tree, tvbuff_t *tvb, int offset)
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] offset    current byte offset in packet being processed
  *
@@ -2322,7 +2294,7 @@ dissect_eigrp_wide_metric (proto_tree *tree, tvbuff_t *tvb, int offset)
  *                                           packet_info *pinfo, guint16 tlv)
 
  *
- * @param[in|out] tree  detail dissection result
+ * @param[in,out] tree  detail dissection result
  * @param[in] tvb       packet data
  * @param[in] ti        protocol item
  * @param[in] pinfo     general data about the protocol
@@ -2421,8 +2393,7 @@ dissect_eigrp_multi_protocol_tlv (proto_item *ti, proto_tree *tree, tvbuff_t *tv
  *
  * @param[in] tvb       packet data
  * @param[in] pinfo     general data about the protocol
- * @param[in|out] tree  detail dissection result
- * @param[out] None
+ * @param[in,out] tree  detail dissection result
  *
  * @return int          0 if packet is not for this decoder
  *
@@ -2610,11 +2581,6 @@ dissect_eigrp (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _
 /**
  *@fn void proto _ register _ eigrp (void)
  *
- * @param[in] void
- * @param[out] None
- *
- * @return void
- *
  * @usage
  *      you can not have the function name inside a comment or else Wireshark
  *      will fail with "duplicate protocol" error.  Dont you hate it when tools
@@ -3352,11 +3318,6 @@ proto_register_eigrp(void)
 /**
  *@fn void proto_reg_handoff_eigrp(void)
  *
- * @param[in] void
- * @param[out] None
- *
- * @return void
- *
  * @usage
  * This exact format is required because a script is used to find these
  * routines and create the code that calls these routines.