Diff: net/net.h

Revision:

5:c56386b9fc33

Parent:

2:e8e09adc41fc

--- a/net/net.h	Tue Oct 12 06:21:05 2010 +0000
+++ b/net/net.h	Tue Oct 12 06:37:21 2010 +0000
@@ -1,3 +1,12 @@
+/**
+ @file net.h
+ @brief This file encompasses all of the networking headers and includes them automatically
+ 
+ This file has some utility functions and definitions used by all of the networking headers,
+ and includes them all.  This is the only file necessary to include to use all of the networking
+ facilities in nettool
+*/
+
 #ifndef NETWORK_H
 #define NETWORK_H
 
@@ -6,8 +15,6 @@
 
 #include "ctype.h"
 
-/// \file Overall networking header - Includes all other net/ headers
-
 /// General networking checksum - Used for IP, TCP, UDP, ICMP, etc.
 /// Computes the one's complement of the one's complement sum of all of the given bytes except for the memory
 /// at skip_byte for skip_count bytes (e.g. the checksum).  Optionally resumes computation from the (given) last checksum.