From a72ca2d1a28f8ba9c0f7392718c96da8c23eb06f Mon Sep 17 00:00:00 2001
From: teastep <teastep@fbd18981-670d-0410-9b5c-8dc0c1a9a2bb>
Date: Wed, 18 Apr 2007 23:43:54 +0000
Subject: [PATCH] Add some comments in the Module headers

git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@6011 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
---
 Shorewall-perl/Shorewall/Chains.pm | 3 +++
 Shorewall-perl/Shorewall/Common.pm | 4 ++++
 Shorewall-perl/Shorewall/Config.pm | 4 ++++
 Shorewall-perl/Shorewall/Zones.pm  | 1 +
 4 files changed, 12 insertions(+)

diff --git a/Shorewall-perl/Shorewall/Chains.pm b/Shorewall-perl/Shorewall/Chains.pm
index ef3744afb..7bb5c6479 100644
--- a/Shorewall-perl/Shorewall/Chains.pm
+++ b/Shorewall-perl/Shorewall/Chains.pm
@@ -20,6 +20,9 @@
 #       along with this program; if not, write to the Free Software
 #       Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
 #
+#  This is the low-level iptables module. It provides the basic services 
+#  of chain and rule creation. It is used by the higher level modules such
+#  as Rules to create iptables-restore input.
 #
 package Shorewall::Chains;
 require Exporter;
diff --git a/Shorewall-perl/Shorewall/Common.pm b/Shorewall-perl/Shorewall/Common.pm
index e858d5742..23d60a168 100644
--- a/Shorewall-perl/Shorewall/Common.pm
+++ b/Shorewall-perl/Shorewall/Common.pm
@@ -20,6 +20,10 @@
 #       along with this program; if not, write to the Free Software
 #       Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
 #
+#   This is the lowes level Shorewall module. It provides very basic 
+#   services such as creation of temporary 'object' files, writing
+#   into those files (emitters) and finalizing those files (renaming 
+#   them to their final name and setting their mode appropriately).
 #
 package Shorewall::Common;
 require Exporter;
diff --git a/Shorewall-perl/Shorewall/Config.pm b/Shorewall-perl/Shorewall/Config.pm
index ff2fdf574..b396ded44 100644
--- a/Shorewall-perl/Shorewall/Config.pm
+++ b/Shorewall-perl/Shorewall/Config.pm
@@ -20,6 +20,10 @@
 #       along with this program; if not, write to the Free Software
 #       Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
 #
+#   This module is responsible for lower level configuration file handling.
+#   It also exports functions for generating warning and error messages.
+#   The get_configuration function parses the shorewall.conf, capabilities and 
+#   modules files during compiler startup.
 #
 package Shorewall::Config;
 
diff --git a/Shorewall-perl/Shorewall/Zones.pm b/Shorewall-perl/Shorewall/Zones.pm
index 2028f6b36..1f69d1177 100644
--- a/Shorewall-perl/Shorewall/Zones.pm
+++ b/Shorewall-perl/Shorewall/Zones.pm
@@ -20,6 +20,7 @@
 #       along with this program; if not, write to the Free Software
 #       Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
 #
+#   This module contains the code which deals with /etc/shorewall/zones.
 #
 package Shorewall::Zones;
 require Exporter;