summaryrefslogtreecommitdiff
path: root/LedgerSMB/Database.pm
diff options
context:
space:
mode:
authoreinhverfr <einhverfr@4979c152-3d1c-0410-bac9-87ea11338e46>2007-06-24 23:32:42 +0000
committereinhverfr <einhverfr@4979c152-3d1c-0410-bac9-87ea11338e46>2007-06-24 23:32:42 +0000
commitdbada5020e51a999fa67967d3e343f79d76ee2a5 (patch)
tree15545c1c2391a192d2392ca5a4981cde35a6de4e /LedgerSMB/Database.pm
parent58fb79e0482144a13ea309bec9019a7c9d9c0957 (diff)
Attempting to fix POD issues with new DB module
git-svn-id: https://ledger-smb.svn.sourceforge.net/svnroot/ledger-smb/trunk@1316 4979c152-3d1c-0410-bac9-87ea11338e46
Diffstat (limited to 'LedgerSMB/Database.pm')
-rw-r--r--LedgerSMB/Database.pm41
1 files changed, 26 insertions, 15 deletions
diff --git a/LedgerSMB/Database.pm b/LedgerSMB/Database.pm
index 8e87592f..79e2ac0d 100644
--- a/LedgerSMB/Database.pm
+++ b/LedgerSMB/Database.pm
@@ -1,14 +1,22 @@
#!/usr/bin/perl
=head1 NAMR
- LedgerSMB::Database
+
+LedgerSMB::Database
+
=head1 SYNOPSIS
- This module provides the APIs for database creation and management
+
+This module provides the APIs for database creation and management
+
=head1 COPYRIGHT
- This module is copyright (C) 2007, the LedgerSMB Core Team and subject to
- the GNU General Public License (GPL) version 2, or at your option, any later
- version. See the COPYRIGHT and LICENSE files for more information.
+
+This module is copyright (C) 2007, the LedgerSMB Core Team and subject to
+the GNU General Public License (GPL) version 2, or at your option, any later
+version. See the COPYRIGHT and LICENSE files for more information.
+
=head1 METHODS
+=over
+
=cut
# Methods are documented inline.
@@ -21,17 +29,18 @@ use LedgerSMB::Sysconfig;
use base('LedgerSMB');
=item LedgerSMB::Database->new({dbname = $dbname, countrycode = $cc, chart_name = $name, company_name = $company, username = $username, password = $password})
- This function creates a new database management object with the specified
- characteristics. The $dbname is the name of the database. the countrycode
- is the two-letter ISO code. The company name is the friendly name for
- dropdown boxes on the Login screen.
- As some countries may have multiple available charts, you can also specify
- a chart name as well.
+This function creates a new database management object with the specified
+characteristics. The $dbname is the name of the database. the countrycode
+is the two-letter ISO code. The company name is the friendly name for
+dropdown boxes on the Login screen.
+
+As some countries may have multiple available charts, you can also specify
+a chart name as well.
- Note that the arguments can be any hashref. If it is a LedgerSMB object,
- however, it will attempt to copy all attributes beginning with _ into the
- current object (_user, _locale, etc).
+Note that the arguments can be any hashref. If it is a LedgerSMB object,
+however, it will attempt to copy all attributes beginning with _ into the
+current object (_user, _locale, etc).
=cut
@@ -54,7 +63,9 @@ sub new {
}
=item $db->create();
- Creates a database with the characteristics in the object
+
+Creates a database with the characteristics in the object
+
=cut
sub create {