SF.net SVN: ledger-smb:[3606] trunk

[..hidden..]

Revision: 3606
          http://ledger-smb.svn.sourceforge.net/ledger-smb/?rev=3606&view=rev
Author:   einhverfr
Date:     2011-07-30 20:00:39 +0000 (Sat, 30 Jul 2011)

Log Message:
-----------
First stage of new code documentation/review complete.  No more pruning before 1.3.0

Modified Paths:
--------------
    trunk/LedgerSMB/CancelFurtherProcessing.pm
    trunk/LedgerSMB/DBObject/Menu.pm
    trunk/t/98-pod-coverage.t

Modified: trunk/LedgerSMB/CancelFurtherProcessing.pm
===================================================================
--- trunk/LedgerSMB/CancelFurtherProcessing.pm	2011-07-30 19:44:09 UTC (rev 3605)
+++ trunk/LedgerSMB/CancelFurtherProcessing.pm	2011-07-30 20:00:39 UTC (rev 3606)
@@ -1,5 +1,22 @@
 package CancelFurtherProcessing;
 
+=head1 NAME
+
+CancelFurtherProcessing
+
+=head1 SYNOPSIS
+
+A simple wrapper around Error.pm for error trapping.
+
+
+=head1 Copyright (C) 2011 The LedgerSMB Core Team
+
+Licensed under the GNU General Public License version 2 or later (at your 
+option).  For more information please see the included LICENSE and COPYRIGHT 
+files.
+
+=cut
+
 use base qw(Error);
 
 1;

Modified: trunk/LedgerSMB/DBObject/Menu.pm
===================================================================
--- trunk/LedgerSMB/DBObject/Menu.pm	2011-07-30 19:44:09 UTC (rev 3605)
+++ trunk/LedgerSMB/DBObject/Menu.pm	2011-07-30 20:00:39 UTC (rev 3606)
@@ -24,11 +24,11 @@
 
 =over
 
-=item LedgerSMB::Menu->new()
+=item new()
 
 Inherited from LedgerSMB::DBObject.  Please see that documnetation for details.
 
-=item $menu->generate()
+=item generate()
 
 This function returns a list of menu items.  Each list item is a hashref:
 keys %menu_item would return the equivalent of qw(position id level label path 
@@ -46,10 +46,8 @@
     return @{$self->{menu_items}};
 }
 
-=over
+=item generate_section()
 
-=item Menu::generate_secton($object)
-
 This class acts like Menu::Generate except it returns only a cross-section of 
 the menu.  Basically it returns all nodes which are direct children below
 $object->{parent_id}.
@@ -65,15 +63,11 @@
     return @{$self->{menu_items}};
 }
 
-=over
+=item will_expire_soon()
 
-=item Menu::will_expire_soon($object)
-
 This method returns true if the user's password will expire soon 
 (within the next week).
 
-=back
-
 =cut
 
 sub will_expire_soon {
@@ -106,3 +100,13 @@
     }
 }
 
+=back
+
+=head1 Copyright (C) 2007 The LedgerSMB Core Team
+
+Licensed under the GNU General Public License version 2 or later (at your 
+option).  For more information please see the included LICENSE and COPYRIGHT 
+files.
+
+=cut
+

Modified: trunk/t/98-pod-coverage.t
===================================================================
--- trunk/t/98-pod-coverage.t	2011-07-30 19:44:09 UTC (rev 3605)
+++ trunk/t/98-pod-coverage.t	2011-07-30 20:00:39 UTC (rev 3606)
@@ -13,7 +13,7 @@
 if ($@){
     plan skip_all => "Test::Pod::Coverage required for testing POD coverage";
 } else {
-    plan tests => 29;
+    plan tests => 31;
 }
 pod_coverage_ok("LedgerSMB");
 pod_coverage_ok("LedgerSMB::Form");
@@ -45,5 +45,7 @@
 );
 pod_coverage_ok("LedgerSMB::DBObject::Reconciliation");
 pod_coverage_ok("LedgerSMB::DBObject::TaxForm");
+pod_coverage_ok("LedgerSMB::CancelFurtherProcessing");
+pod_coverage_ok("LedgerSMB::DBObject::Menu");
 pod_coverage_ok("LedgerSMB::DBObject::EOY");
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.