Ethereal-dev: [Ethereal-dev] Nits and Dox Patch

Note: This archive is from the project's previous web site, ethereal.com. This list is no longer active.

From: Michael Duigou <ethereal@xxxxxxxxxx>
Date: Fri, 11 Mar 2005 17:43:56 -0800
Some minor nits that gcc was complaining about and additional doxygen comments.

Mike
Index: epan/dissectors/packet-tcp.h
===================================================================
--- epan/dissectors/packet-tcp.h	(revision 13726)
+++ epan/dissectors/packet-tcp.h	(working copy)
@@ -51,7 +51,8 @@
 };
 
 /*
- * Private data passed from the TCP dissector to subdissectors.
+ * Private data passed from the TCP dissector to subdissectors. Passed to the 
+ * subdissectors in pinfo->private_data
  */
 struct tcpinfo {
 	guint32 seq;             /* Sequence number of first byte in the data */
Index: epan/packet.h
===================================================================
--- epan/packet.h	(revision 13726)
+++ epan/packet.h	(working copy)
@@ -375,6 +375,6 @@
  * Dump layer/selector/dissector records in a fashion similar to the
  * proto_registrar_dump_* routines.
  */
-extern void dissector_dump_decodes();
+extern void dissector_dump_decodes(void);
 
 #endif /* packet.h */
Index: epan/req_resp_hdrs.h
===================================================================
--- epan/req_resp_hdrs.h	(revision 13726)
+++ epan/req_resp_hdrs.h	(working copy)
@@ -26,8 +26,15 @@
 #ifndef __REQ_RESP_HDRS_H__
 #define __REQ_RESP_HDRS_H__
 
-/*
+/**
  * Optionally do reassembly of the request/response line, headers, and body.
+ *
+ *  @param tvb  The buffer.
+ *  @param offset   The offset in the buffer to begin inspection.
+ *  @param pinfo    Packet info from the parent protocol.
+ *  @param desegment_headers    Do desegmentation on headers.
+ *  @param desegment_body   Do desegmenation on body.
+ *  @return TRUE if desegmentation is complete otherwise FALSE
  */
 extern gboolean
 req_resp_hdrs_do_reassembly(tvbuff_t *tvb, int offset, packet_info *pinfo,