v4 doc changes

Info/Layer3/Foundry.pm

@@ -28,7 +28,7 @@
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 package SNMP::Info::Layer3::Foundry;
-$VERSION = 0.3;
+$VERSION = 0.4;
 # $Id$
 
 use strict;
@@ -222,16 +222,7 @@ __END__
 
 =head1 NAME
 
-SNMP::Info::Layer3::Foundry - Perl5 Interface to Foundry Network Devices
+SNMP::Info::Layer3::Foundry - Perl5 Interface to Foundry FastIron Network Devices
-
-=head1 DESCRIPTION
-
-This module provides limited functionality from older Foundry devices.
-Specifically designed for a FI4802
-
-Data comes RFC1213 and FOUNDRY-SN-ROOT-MIB
-
-Inherits all methods from both SNMP::Info and SNMP::Info::Bridge
 
 =head1 AUTHOR
 
@@ -239,30 +230,60 @@ Max Baker (C<max@warped.org>)
 
 =head1 SYNOPSIS
 
- my $foundry = new SNMP::Info::Layer3::Foundry(DestHost  => 'switch' , 
+ # Let SNMP::Info determine the correct subclass for you. 
-                              Community => 'public' ); 
+ my $foundry = new SNMP::Info(
+                          AutoSpecify => 1,
+                          Debug       => 1,
+                          # These arguments are passed directly on to SNMP::Session
+                          DestHost    => 'myswitch',
+                          Community   => 'public',
+                          Version     => 1
+                        ) 
+    or die "Can't connect to DestHost.\n";
 
-See L<SNMP::Info> and L<SNMP::Info::Layer3> for all inherited methods.
+ my $class      = $foundry->class();
+ print "SNMP::Info determined this device to fall under subclass : $class\n";
 
-=head1 CREATING AN OBJECT
+=head1 DESCRIPTION
+
+This subclass no longer supported.
+
+This module provides limited functionality from older Foundry devices.
+
+Specifically designed for a FI4802.
+
+For speed or debugging purposes you can call the subclass directly, but not after determining
+a more specific class using the method above.  Turn off the AutoSpecify flag.
+
+ my $foundry = new SNMP::Info::Layer3::Foundry(...);
+
+=head2 Inherited Classes
 
 =over
 
-=item  new SNMP::Info::Layer3::Foundry()
+=item SNMP::Info
 
-Arguments passed to new() are passed on to SNMP::Session::new()
+=item SNMP::Info::Bridge
-    
-
-    my $foundry = new SNMP::Info::Layer3::Foundry(
-        DestHost => $host,
-        Community => 'public',
-        Version => 3,...
-        ) 
-    die "Couldn't connect.\n" unless defined $foundry;
 
 =back
 
-=head1 GLOBAL VALUES
+=head2 Required MIBs
+
+=over
+
+=item FOUNDRY-SN-ROOT-MIB
+
+=item Inherited Classes' MIBs
+
+See classes listed above for their required MIBs.
+
+=back
+
+The Foundry MIBS can be downloaded from www.mibdepot.com and ??
+
+=head1 GLOBALS
+
+These are methods that return scalar value from SNMP
 
 =over
 
@@ -319,8 +340,19 @@ Arguments passed to new() are passed on to SNMP::Session::new()
 
 =back
 
+=head2 Globals imported from SNMP::Info
+
+See documentation in SNMP::Info for details.
+
+=head2 Globals imported from SNMP::Info::Bridge
+
+See documentation in SNMP::Info::Bridge for details.
+
 =head1 TABLE ENTRIES
 
+These are methods that return tables of information in the form of a reference
+to a hash.
+
 =head2 Overrides
 
 =over
@@ -417,4 +449,12 @@ Arguments passed to new() are passed on to SNMP::Session::new()
 
 =back
 
+=head2 Table Methods imported from SNMP::Info
+
+See documentation in SNMP::Info for details.
+
+=head2 Table Methods imported from SNMP::Info::Bridge
+
+See documentation in SNMP::Info::Bridge for details.
+
 =cut