More module comments

git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@6012 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb

Shorewall-perl/Shorewall/Accounting.pm

@@ -20,8 +20,9 @@
 #       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 that handles the /etc/shorewall/accounting
+#   file.
 #
-
 package Shorewall::Accounting;
 require Exporter;
 use Shorewall::Common;

Shorewall-perl/Shorewall/Actions.pm

@@ -20,6 +20,8 @@
 #       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 for dealing with actions (built-in,
+#   standard and user-defined).
 #
 package Shorewall::Actions;
 require Exporter;

Shorewall-perl/Shorewall/Hosts.pm

@@ -20,6 +20,8 @@
 #       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 for dealing with the /etc/shorewall/hosts
+#  file.
 #
 package Shorewall::Hosts;
 require Exporter;

Shorewall-perl/Shorewall/Interfaces.pm

@@ -20,7 +20,11 @@
 #       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 for processing the /etc/shorewall/interfaces
+#   file. It also exports 'add_group_to_zone()' which other modules call to
+#   alter zone membership.
 #
+
 package Shorewall::Interfaces;
 require Exporter;
 use Shorewall::Common;

Shorewall-perl/Shorewall/Macros.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 exports some low-level module-oriented functions.
 #
 package Shorewall::Macros;
 require Exporter;

Shorewall-perl/Shorewall/Nat.pm

@@ -20,6 +20,8 @@
 #       along with this program; if not, write to the Free Software
 #       Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
 #
+#   This module contains code for dealing with the /etc/shorewall/masq,
+#   /etc/shorewall/nat and /etc/shorewall/netmap files.
 #
 package Shorewall::Nat;
 require Exporter;

Shorewall-perl/Shorewall/Policy.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 deals with the /etc/shorewall/policy file.
 #
 package Shorewall::Policy;
 require Exporter;

Shorewall-perl/Shorewall/Proc.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 contains the code that deals with entries in /proc.
+#
+#   Note: The /proc/sys/net/ipv4/conf/x/proxy_arp flag is handled
+#         in the Proxyarp module.
 #
 package Shorewall::Proc;
 require Exporter;

Shorewall-perl/Shorewall/Providers.pm

@@ -20,6 +20,8 @@
 #       along with this program; if not, write to the Free Software
 #       Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
 #
+#   This module deals with the /etc/shorewall/providers and
+#   /etc/shorewall/route_rules files.
 #
 package Shorewall::Providers;
 require Exporter;

Shorewall-perl/Shorewall/Rules.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 high-level code for dealing with rules.
 #
 package Shorewall::Rules;
 require Exporter;

Shorewall-perl/Shorewall/Tc.pm

@@ -25,6 +25,7 @@
 #       along with this program; if not, write to the Free Software
 #       Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
 #
+#   This module deals with Traffic Shaping and the tcrules file.
 #
 package Shorewall::Tc;
 require Exporter;

Shorewall-perl/Shorewall/Tunnels.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 handles the /etc/shorewall/tunnels file.
 #
 package Shorewall::Tunnels;
 require Exporter;