osmocom
/
wireshark
14
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

Fix (-W)documentation error found by Clang 

./packet-mstp.h:31:13: error: empty paragraph passed to '@param' command
      [-Werror,-Wdocumentation]
 * @param val
   ~~~~~~~~~^
./packet-mstp.h:41:13: error: empty paragraph passed to '@param' command
      [-Werror,-Wdocumentation]
 * @param tvb
   ~~~~~~~~~^
./packet-mstp.h:42:15: error: empty paragraph passed to '@param' command
      [-Werror,-Wdocumentation]
 * @param pinfo
   ~~~~~~~~~~~^
./packet-mstp.h:43:14: error: empty paragraph passed to '@param' command
      [-Werror,-Wdocumentation]
 * @param tree
   ~~~~~~~~~~^
./packet-mstp.h:44:17: error: empty paragraph passed to '@param' command
      [-Werror,-Wdocumentation]
 * @param subtree
   ~~~~~~~~~~~~~^
./packet-mstp.h:45:16: error: empty paragraph passed to '@param' command
      [-Werror,-Wdocumentation]
 * @param offset
   ~~~~~~~~~~~~^
./packet-mstp.h:46:5: error: '@return' command used in a comment that is
      attached to a function returning void [-Werror,-Wdocumentation]
 * @return none
   ~^~~~~~~~~~~

svn path=/trunk/; revision=51264
This commit is contained in:
Alexis La Goutte 2013-08-10 21:29:24 +00:00
parent 33b09b4674
commit 9381244dd8
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
epan/dissectors/packet-mstp.h
View File

@ -28,7 +28,7 @@
/** /**
* Returns a value string for the BACnet MS/TP Frame Type. * Returns a value string for the BACnet MS/TP Frame Type.
* @param val * @param val BACnet MS/TP Frame value
* @return constant C String with MS/TP Frame Type * @return constant C String with MS/TP Frame Type
*/ */
const gchar * const gchar *
@ -38,12 +38,11 @@ mstp_frame_type_text(guint32 val);
* Dissects the BACnet MS/TP packet after the preamble, * Dissects the BACnet MS/TP packet after the preamble,
* starting with the MS/TP Frame type octet. Passes * starting with the MS/TP Frame type octet. Passes
* the PDU, if there is one, to the BACnet dissector. * the PDU, if there is one, to the BACnet dissector.
* @param tvb * @param tvb the tv buffer of the current data
* @param pinfo * @param pinfo the packet info of the current data
* @param tree * @param tree the tree to append this item to
* @param subtree * @param subtree the sub tree to append this item to
* @param offset * @param offset the offset in the tvb
* @return none
*/ */
void void
dissect_mstp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, proto_tree *subtree, gint offset); dissect_mstp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, proto_tree *subtree, gint offset);