Clean up comments.

diff --git a/pcap-rpcap-int.h b/pcap-rpcap-int.h
index 148056f6d79f2c7373e3b337edecc180a6051988..2bd295d92ddee21866de7d589a76812bc70511e2 100644 (file)
--- a/pcap-rpcap-int.h
+++ b/pcap-rpcap-int.h
@@ -31,17 +31,17 @@
  *
  */
 
-#ifndef __PCAP_REMOTE_H__
-#define __PCAP_REMOTE_H__
+#ifndef __PCAP_RPCAP_INT_H__
+#define __PCAP_RPCAP_INT_H__
 
 #include "pcap.h"
 #include "sockutils.h" /* Needed for some structures (like SOCKET, sockaddr_in) which are used here */
 
 /*
- * \file pcap-rpcap.h
+ * \file pcap-rpcap-int.h
  *
- * This file keeps all the new definitions and typedefs that are exported to the user and
- * that are needed for the RPCAP protocol.
+ * This file keeps all the definitions used by the RPCAP client and server,
+ * other than the protocol definitions.
  *
  * \warning All the RPCAP functions that are allowed to return a buffer containing
  * the error description can return max PCAP_ERRBUF_SIZE characters.
@@ -50,16 +50,6 @@
  * and to insert manually the termination char at the end of the buffer. This will
  * guarantee that no buffer overflows occur even if we use the printf() to show
  * the error on the screen.
- *
- * \warning This file declares some typedefs that MUST be of a specific size.
- * These definitions (i.e. typedefs) could need to be changed on other platforms than
- * Intel IA32.
- *
- * \warning This file defines some structures that are used to transfer data on the network.
- * Be careful that you compiler MUST not insert padding into these structures
- * for better alignment.
- * These structures have been created in order to be correctly aligned to a 32 bits
- * boundary, but be careful in any case.
  */
 
 /*********************************************************

diff --git a/rpcap/rpcap-protocol.h b/rpcap/rpcap-protocol.h
index 264c60d03e1fd7da0e32242c42e42a3c4d795101..edb7b239e946c82b0e8a4a44b5eddcacc264f95e 100644 (file)
--- a/rpcap/rpcap-protocol.h
+++ b/rpcap/rpcap-protocol.h
@@ -55,9 +55,22 @@
  * Protocol messages formats                             *
  *                                                       *
  *********************************************************/
-/* WARNING Take care you compiler does not insert padding for better alignments into these structs */
+/*
+ * WARNING: This file defines some structures that are used to transfer
+ * data on the network.
+ * Note that your compiler MUST not insert padding into these structures
+ * for better alignment.
+ * These structures have been created in order to be correctly aligned to
+ * a 32-bit boundary, but be careful in any case.
+ */
 
-/* WARNING: These might need to be changed on other platforms */
+/*
+ * WARNING: These typedefs MUST be of a specific size.
+ * You might have to change them on your platform.
+ *
+ * XXX - use the C99 types?  Microsoft's newer versions of Visual Studio
+ * support them.
+ */
 typedef unsigned char uint8;   /* 8-bit unsigned integer */
 typedef unsigned short uint16; /* 16-bit unsigned integer */
 typedef unsigned int uint32;   /* 32-bit unsigned integer */