Correct NAME section POD in various *.pm files.

git-svn-id: https://ledger-smb.svn.sourceforge.net/svnroot/ledger-smb/branches/1.3@4584 4979c152-3d1c-0410-bac9-87ea11338e46
jfkw · Mar 26, 2012 · 68e3173 · 68e3173
1 parent f9597b8
commit 68e3173
Show file tree

Hide file tree

Showing 12 changed files with 28 additions and 16 deletions.
diff --git a/LedgerSMB.pm b/LedgerSMB.pm
@@ -1,7 +1,7 @@
 
 =head1 NAME
 
-LedgerSMB  The Base class for many LedgerSMB objects, including DBObject.
+LedgerSMB - The Base class for many LedgerSMB objects, including DBObject.
 
 =head1 SYNOPSIS
 

diff --git a/LedgerSMB/AA.pm b/LedgerSMB/AA.pm
@@ -4,7 +4,7 @@
 
 LedgerSMB::AA - Contains the routines for managing AR and AP transactions.
 
-=head1 SYNPOSIS
+=head1 SYNOPSIS
 
 This module contains the routines for managing AR and AP transactions and 
 many of the reorts (a few others are found in LedgerSMB::RP.pm).

diff --git a/LedgerSMB/Auth.pm b/LedgerSMB/Auth.pm
@@ -2,7 +2,8 @@
 
 =head1 NAME
 
-LedgerSMB::Auth.pm
+LedgerSMB::Auth.pm - Provides an abstraction layer for session management and
+authentication.
 
 =head1 SYNOPSIS
 

diff --git a/LedgerSMB/Auth/DB.pm b/LedgerSMB/Auth/DB.pm
@@ -3,7 +3,7 @@
 
 =head1 NAME
 
-LedgerSMB::Auth.pm, Standard DB module.
+LedgerSMB::Auth::DB - Standard Authentication DB module.
 
 =head1 SYNOPSIS
 

diff --git a/LedgerSMB/File.pm b/LedgerSMB/File.pm
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-LedgerSMB::File
+LedgerSMB::File - Provides routines for managing file attachments.
 
 =head1 SYNPSIS
 

diff --git a/LedgerSMB/File/Order.pm b/LedgerSMB/File/Order.pm
@@ -2,9 +2,9 @@
 
 =head1 NAME
 
-LedgerSMB::File::Order
+LedgerSMB::File::Order - Manages attachments to orders.
 
-=head1 SYNPSIS
+=head1 SYNOPSIS
 
 Manages attachments to orders (sales orders, purchase orders, quotations and
 RFQ's).

diff --git a/LedgerSMB/File/Part.pm b/LedgerSMB/File/Part.pm
@@ -2,9 +2,9 @@
 
 =head1 NAME
 
-LedgerSMB::File::Part
+LedgerSMB::File::Part - Manages attachments to goods and services.
 
-=head1 SYNPSIS
+=head1 SYNOPSIS
 
 Manages attachments to goods and services.
 

diff --git a/LedgerSMB/File/Transaction.pm b/LedgerSMB/File/Transaction.pm
@@ -2,11 +2,11 @@
 
 =head1 NAME
 
-LedgerSMB::File::Transaction
+LedgerSMB::File::Transaction - Manages attachments to financial transactions.
 
-=head1 SYNPSIS
+=head1 SYNOPSIS
 
-Manages attachments to financial trnasactions (in 1.3, AR, AP, and GL entries)
+Manages attachments to financial transactions (in 1.3, AR, AP, and GL entries)
 
 =head1 INHERITS
 

diff --git a/LedgerSMB/RESTXML/Document/Base.pm b/LedgerSMB/RESTXML/Document/Base.pm
@@ -1,3 +1,9 @@
+=head1 NAME
+
+LedgerSMB::RESTXML::Document::Base - Base XML:Twig structure function
+
+=cut
+
 package LedgerSMB::RESTXML::Document::Base;
 use strict;
 use warnings;

diff --git a/LedgerSMB/RESTXML/Document/Session.pm b/LedgerSMB/RESTXML/Document/Session.pm
@@ -1,7 +1,7 @@
 
 =head1 NAME
 
-LedgerSMB::RESTXML::Document::Session
+LedgerSMB::RESTXML::Document::Session - Sets up an authentication session for iterativly accessing documents.
 
 =head1 SYNOPSIS
 

diff --git a/LedgerSMB/RESTXML/Handler.pm b/LedgerSMB/RESTXML/Handler.pm
@@ -1,3 +1,10 @@
+
+=head1 NAME
+
+LedgerSMB::RESTXML::Handler - RESTful LSMB API
+
+=cut
+
 package LedgerSMB::RESTXML::Handler;
 use strict;
 use warnings;

diff --git a/LedgerSMB/ScriptLib/Company.pm b/LedgerSMB/ScriptLib/Company.pm
@@ -210,7 +210,7 @@ Requires form var: id
 
 Extracts a single company from the database, using its company ID as the primary
 point of uniqueness. Shows (appropriate to user privileges) and allows editing
-of the company informations.
+of the company information.
 
 =back
 
@@ -515,8 +515,6 @@ l_projectnumber: project.projectnumber
 l_serialnumber:  invoice/orderitems.serialnumber
 
 
-=item 
-
 =back
 
 =cut