aboutsummaryrefslogtreecommitdiffstats
path: root/epan/dissectors/packet-mstp.h
diff options
context:
space:
mode:
authorAlexis La Goutte <alexis.lagoutte@gmail.com>2013-08-10 21:29:24 +0000
committerAlexis La Goutte <alexis.lagoutte@gmail.com>2013-08-10 21:29:24 +0000
commit9381244dd8eac88ab82cbc9a9410802d8334e4d3 (patch)
tree40e93037dbb73f63692e66c433e5e1d68a5ae45c /epan/dissectors/packet-mstp.h
parent33b09b4674d97971337b68db045c9bd7ab9197f3 (diff)
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
Diffstat (limited to 'epan/dissectors/packet-mstp.h')
-rw-r--r--epan/dissectors/packet-mstp.h13
1 files changed, 6 insertions, 7 deletions
diff --git a/epan/dissectors/packet-mstp.h b/epan/dissectors/packet-mstp.h
index 0330d7fbce..f19f48c2bc 100644
--- a/epan/dissectors/packet-mstp.h
+++ b/epan/dissectors/packet-mstp.h
@@ -28,7 +28,7 @@
/**
* 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
*/
const gchar *
@@ -38,12 +38,11 @@ mstp_frame_type_text(guint32 val);
* Dissects the BACnet MS/TP packet after the preamble,
* starting with the MS/TP Frame type octet. Passes
* the PDU, if there is one, to the BACnet dissector.
- * @param tvb
- * @param pinfo
- * @param tree
- * @param subtree
- * @param offset
- * @return none
+ * @param tvb the tv buffer of the current data
+ * @param pinfo the packet info of the current data
+ * @param tree the tree to append this item to
+ * @param subtree the sub tree to append this item to
+ * @param offset the offset in the tvb
*/
void
dissect_mstp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, proto_tree *subtree, gint offset);