[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
SF.net SVN: ledger-smb: [1202] trunk
- Subject: SF.net SVN: ledger-smb: [1202] trunk
- From: ..hidden..
- Date: Wed, 16 May 2007 17:21:22 -0700
Revision: 1202
http://svn.sourceforge.net/ledger-smb/?rev=1202&view=rev
Author: tetragon
Date: 2007-05-16 17:21:22 -0700 (Wed, 16 May 2007)
Log Message:
-----------
POD fixes and POD syntax tests
Modified Paths:
--------------
trunk/LedgerSMB/Contact.pm
trunk/LedgerSMB/DBObject.pm
trunk/LedgerSMB/Employee.pm
trunk/LedgerSMB/Locale.pm
trunk/LedgerSMB/Location.pm
trunk/LedgerSMB/Setting.pm
trunk/LedgerSMB/Template/HTML.pm
trunk/LedgerSMB/Template.pm
trunk/LedgerSMB.pm
Added Paths:
-----------
trunk/t/97-pod.t
Modified: trunk/LedgerSMB/Contact.pm
===================================================================
--- trunk/LedgerSMB/Contact.pm 2007-05-16 23:22:22 UTC (rev 1201)
+++ trunk/LedgerSMB/Contact.pm 2007-05-17 00:21:22 UTC (rev 1202)
@@ -10,21 +10,27 @@
=head1 METHODS
The following method is static:
+
+=over
+
=item new ($LedgerSMB object);
The following methods are passed through to stored procedures via Autoload.
=item save
+
=item get
+
=item search
The above list may grow over time, and may depend on other installed modules.
+=back
+
=head1 Copyright (C) 2007, The LedgerSMB core team.
+
This file is licensed under the Gnu General Public License version 2, or at your
option any later version. A copy of the license should have been included with
your software.
-=back
-
=cut
Modified: trunk/LedgerSMB/DBObject.pm
===================================================================
--- trunk/LedgerSMB/DBObject.pm 2007-05-16 23:22:22 UTC (rev 1201)
+++ trunk/LedgerSMB/DBObject.pm 2007-05-17 00:21:22 UTC (rev 1202)
@@ -9,6 +9,8 @@
=head1 METHODS
+=over
+
=item new ($class, base => $LedgerSMB::hash)
This is the base constructor for all child classes. It must be used with base
@@ -21,16 +23,17 @@
=item exec_method ($self, procname => $function_name, args => ..hidden..)
=item merge ($hashref, @attrs)
+
copies @attrs from $hashref to $self.
+=back
=head1 Copyright (C) 2007, The LedgerSMB core team.
+
This file is licensed under the Gnu General Public License version 2, or at your
option any later version. A copy of the license should have been included with
your software.
-=back
-
=cut
package LedgerSMB::DBObject;
Modified: trunk/LedgerSMB/Employee.pm
===================================================================
--- trunk/LedgerSMB/Employee.pm 2007-05-16 23:22:22 UTC (rev 1201)
+++ trunk/LedgerSMB/Employee.pm 2007-05-17 00:21:22 UTC (rev 1202)
@@ -10,23 +10,35 @@
=head1 METHODS
The following method is static:
+
+=over
+
=item new ($LedgerSMB object);
+=back
+
The following methods are passed through to stored procedures via Autoload.
+
+=over
+
=item save
+
=item get
+
=item search
+
=item list_managers
The above list may grow over time, and may depend on other installed modules.
+=back
+
=head1 Copyright (C) 2007, The LedgerSMB core team.
+
This file is licensed under the Gnu General Public License version 2, or at your
option any later version. A copy of the license should have been included with
your software.
-=back
-
=cut
package LedgerSMB::Employee;
Modified: trunk/LedgerSMB/Locale.pm
===================================================================
--- trunk/LedgerSMB/Locale.pm 2007-05-16 23:22:22 UTC (rev 1201)
+++ trunk/LedgerSMB/Locale.pm 2007-05-17 00:21:22 UTC (rev 1202)
@@ -8,6 +8,8 @@
=head1 METHODS
+=over
+
=item get_handle ($language_code)
Returns a locale handle for accessing the other methods. Inherited from
Locale::Maketext.
@@ -21,42 +23,45 @@
will be givin in the form of "_('September') 23 2007". If $longformat is not
set, the date will be output in the format specified by $myconfig->{dateformat}.
+=back
+
=head1 Copyright (C) 2006, The LedgerSMB core team.
-#=====================================================================
-#
-# Locale support module for LedgerSMB
-# LedgerSMB::Locale
-#
-# LedgerSMB
-# Small Medium Business Accounting software
-# http://www.ledgersmb.org/
-#
-#
-# Copyright (C) 2006
-# This work contains copyrighted information from a number of sources all used
-# with permission. It is released under the GNU General Public License
-# Version 2 or, at your option, any later version. See COPYRIGHT file for
-# details.
-#
-# This file contains source code included with or based on SQL-Ledger which
-# is Copyright Dieter Simader and DWS Systems Inc. 2000-2005 and licensed
-# under the GNU General Public License version 2 or, at your option, any later
-# version. For a full list including contact information of contributors,
-# maintainers, and copyright holders, see the CONTRIBUTORS file.
-#
-# Original Copyright Notice from SQL-Ledger 2.6.17 (before the fork):
-# Copyright (C) 2000
-#
-# Author: DWS Systems Inc.
-# Web: http://www.sql-ledger.org
-#
-# Contributors: Thomas Bayen <..hidden..>
-# Antti Kaihola <..hidden..>
-# Moritz Bunkus (tex)
-# Jim Rawlings <..hidden..> (DB2)
-#
-#======================================================================
+ #====================================================================
+ #
+ # Locale support module for LedgerSMB
+ # LedgerSMB::Locale
+ #
+ # LedgerSMB
+ # Small Medium Business Accounting software
+ # http://www.ledgersmb.org/
+ #
+ #
+ # Copyright (C) 2006
+ # This work contains copyrighted information from a number of sources
+ # all used with permission. It is released under the GNU General
+ # Public License Version 2 or, at your option, any later version.
+ # See COPYRIGHT file for details.
+ #
+ # This file contains source code included with or based on SQL-Ledger
+ # which is Copyright Dieter Simader and DWS Systems Inc. 2000-2005
+ # and licensed under the GNU General Public License version 2 or, at
+ # your option, any later version. For a full list including contact
+ # information of contributors, maintainers, and copyright holders,
+ # see the CONTRIBUTORS file.
+ #
+ # Original Copyright Notice from SQL-Ledger 2.6.17 (before the fork):
+ # Copyright (C) 2000
+ #
+ # Author: DWS Systems Inc.
+ # Web: http://www.sql-ledger.org
+ #
+ # Contributors: Thomas Bayen <..hidden..>
+ # Antti Kaihola <..hidden..>
+ # Moritz Bunkus (tex)
+ # Jim Rawlings <..hidden..> (DB2)
+ #
+ #====================================================================
=cut
package LedgerSMB::Locale;
Modified: trunk/LedgerSMB/Location.pm
===================================================================
--- trunk/LedgerSMB/Location.pm 2007-05-16 23:22:22 UTC (rev 1201)
+++ trunk/LedgerSMB/Location.pm 2007-05-17 00:21:22 UTC (rev 1202)
@@ -10,24 +10,37 @@
=head1 METHODS
The following method is static:
+
+=over
+
=item new ($LedgerSMB object);
+=back
+
The following methods are passed through to stored procedures:
+
+=over
+
=item save
+
=item get
+
=item search
+
=item list_all
+
=item delete (via Autoload)
+=back
+
The above list may grow over time, and may depend on other installed modules.
=head1 Copyright (C) 2007, The LedgerSMB core team.
+
This file is licensed under the Gnu General Public License version 2, or at your
option any later version. A copy of the license should have been included with
your software.
-=back
-
=cut
package LedgerSMB::Location;
Modified: trunk/LedgerSMB/Setting.pm
===================================================================
--- trunk/LedgerSMB/Setting.pm 2007-05-16 23:22:22 UTC (rev 1201)
+++ trunk/LedgerSMB/Setting.pm 2007-05-17 00:21:22 UTC (rev 1202)
@@ -10,9 +10,17 @@
=head1 METHODS
The following method is static:
+
+=over
+
=item new ($LedgerSMB object);
+=back
+
The following methods are passed through to stored procedures:
+
+=over
+
=item get ($self->{key})
=item get_default_accounts() (via AUTOLOAD) returns a list of accounts.
@@ -20,20 +28,22 @@
=item set ($self->{key}, $self->{value})
=item parse_incriment ($self->{key})
+
This function updates a default entry in the database, incrimenting the last
set of digits not including <?lsmb ?> tags or non-digits, and then parses the
returned value, doing tag substitution. The final value is then returned by
the function.
+=back
+
The above list may grow over time, and may depend on other installed modules.
=head1 Copyright (C) 2007, The LedgerSMB core team.
+
This file is licensed under the Gnu General Public License version 2, or at your
option any later version. A copy of the license should have been included with
your software.
-=back
-
=cut
package LedgerSMB::Setting;
Modified: trunk/LedgerSMB/Template/HTML.pm
===================================================================
--- trunk/LedgerSMB/Template/HTML.pm 2007-05-16 23:22:22 UTC (rev 1201)
+++ trunk/LedgerSMB/Template/HTML.pm 2007-05-17 00:21:22 UTC (rev 1202)
@@ -5,23 +5,28 @@
=head1 METHODS
+=over
+
=item get_template ()
=item preprocess ($vars)
+
This method returns a reference to a hash that contains a copy of the passed
hashref's data with HTML entities converted to escapes.
=item postprocess ()
+=back
+
=head1 Copyright (C) 2007, The LedgerSMB core team.
-# This work contains copyrighted information from a number of sources all used
-# with permission.
-#
-# It is released under the GNU General Public License Version 2 or, at your
-# option, any later version. See COPYRIGHT file for details. For a full list
-# including contact information of contributors, maintainers, and copyright
-# holders, see the CONTRIBUTORS file.
+This work contains copyrighted information from a number of sources all used
+with permission.
+
+It is released under the GNU General Public License Version 2 or, at your
+option, any later version. See COPYRIGHT file for details. For a full list
+including contact information of contributors, maintainers, and copyright
+holders, see the CONTRIBUTORS file.
=cut
use Error qw(:try);
Modified: trunk/LedgerSMB/Template.pm
===================================================================
--- trunk/LedgerSMB/Template.pm 2007-05-16 23:22:22 UTC (rev 1201)
+++ trunk/LedgerSMB/Template.pm 2007-05-17 00:21:22 UTC (rev 1202)
@@ -1,3 +1,4 @@
+
=head1 NAME
LedgerSMB::Template - Template support module for LedgerSMB
@@ -9,13 +10,15 @@
=head1 METHODS
+=over
+
=item new(user => \%myconfig, template => $string, format => 'HTML', [language => $string,] [include_path => $path]);
- This command instantiates a new template:
- template is the file name of the template to be processed.
- format is the type of format to be used. Currently only HTML is supported
- language (optional) specifies the language for template selection.
- include_path allows one to override the template directory and use this with user interface templates.
+This command instantiates a new template:
+template is the file name of the template to be processed.
+format is the type of format to be used. Currently only HTML is supported
+language (optional) specifies the language for template selection.
+include_path allows one to override the template directory and use this with user interface templates.
=item render($hashref)
@@ -27,9 +30,11 @@
This command checks for valid langages. Returns 1 if the language is valid,
0 if it is not.
+=back
+
=head1 Copyright 2007, The LedgerSMB Core Team
-This file is licensed under the Gnu General Public License version 2, or at your
+This file is licensed under the GNU General Public License version 2, or at your
option any later version. A copy of the license should have been included with
your software.
Modified: trunk/LedgerSMB.pm
===================================================================
--- trunk/LedgerSMB.pm 2007-05-16 23:22:22 UTC (rev 1201)
+++ trunk/LedgerSMB.pm 2007-05-17 00:21:22 UTC (rev 1202)
@@ -1,3 +1,4 @@
+
=head1 NAME
LedgerSMB The Base class for many LedgerSMB objects, including DBObject.
@@ -9,10 +10,14 @@
=head1 METHODS
+=over
+
=item new ()
+
This method creates a new base request instance.
=item date_to_number (user => $LedgerSMB::User, date => $string);
+
This function takes the date in the format provided and returns a numeric
string in YYMMDD format. This may be moved to User in the future.
@@ -36,18 +41,22 @@
LedgerSMB::User at some point in the future.
=item parse_amount (user => $LedgerSMB::User::hash, amount => $variable);
+
If $amount is a Bigfloat, it is returned as is. If it is a string, it is
parsed according to the user preferences stored in the LedgerSMB::User object.
=item is_blank (name => $string)
+
This function returns true if $self->{$string} only consists of whitespace
characters or is an empty string.
=item is_run_mode ('(cli|cgi|mod_perl)')
+
This function returns 1 if the run mode is what is specified. Otherwise
returns 0.
=item is_allowed_role(allowed_roles => @role_names)
+
This function returns 1 if the user's roles include any of the roles in
@role_names. Currently it returns 1 when this is not found as well but when
role permissions are introduced, this will change to 0.
@@ -58,6 +67,7 @@
textbox. It returns either that number or max, which ever is lower.
=item merge ($hashref, keys => @list, index => $number);
+
This command merges the $hashref into the current object. If keys are
specified, only those keys are used. Otherwise all keys are merged.
@@ -71,33 +81,37 @@
$msg.
=item redo_rows (fields => ..hidden.., count => $integer, [index => $string);
+
This function is undergoing serious redesign at the moment. If index is
defined, that field is used for ordering the rows. If not, runningnumber is
used. Behavior is not defined when index points to a field containing
non-numbers.
+=back
+
=head1 Copyright (C) 2006, The LedgerSMB core team.
-# This work contains copyrighted information from a number of sources all used
-# with permission.
-#
-# This file contains source code included with or based on SQL-Ledger which
-# is Copyright Dieter Simader and DWS Systems Inc. 2000-2005 and licensed
-# under the GNU General Public License version 2 or, at your option, any later
-# version. For a full list including contact information of contributors,
-# maintainers, and copyright holders, see the CONTRIBUTORS file.
-#
-# Original Copyright Notice from SQL-Ledger 2.6.17 (before the fork):
-# Copyright (C) 2000
-#
-# Author: DWS Systems Inc.
-# Web: http://www.sql-ledger.org
-#
-# Contributors: Thomas Bayen <..hidden..>
-# Antti Kaihola <..hidden..>
-# Moritz Bunkus (tex)
-# Jim Rawlings <..hidden..> (DB2)
-#======================================================================
+ # This work contains copyrighted information from a number of sources
+ # all used with permission.
+ #
+ # This file contains source code included with or based on SQL-Ledger
+ # which is Copyright Dieter Simader and DWS Systems Inc. 2000-2005
+ # and licensed under the GNU General Public License version 2 or, at
+ # your option, any later version. For a full list including contact
+ # information of contributors, maintainers, and copyright holders,
+ # see the CONTRIBUTORS file.
+ #
+ # Original Copyright Notice from SQL-Ledger 2.6.17 (before the fork):
+ # Copyright (C) 2000
+ #
+ # Author: DWS Systems Inc.
+ # Web: http://www.sql-ledger.org
+ #
+ # Contributors: Thomas Bayen <..hidden..>
+ # Antti Kaihola <..hidden..>
+ # Moritz Bunkus (tex)
+ # Jim Rawlings <..hidden..> (DB2)
+ #====================================================================
=cut
use CGI;
Added: trunk/t/97-pod.t
===================================================================
--- trunk/t/97-pod.t (rev 0)
+++ trunk/t/97-pod.t 2007-05-17 00:21:22 UTC (rev 1202)
@@ -0,0 +1,14 @@
+#!/usr/bin/perl
+#
+# t/97-pod.t
+#
+# Checks POD syntax.
+#
+
+use strict;
+use warnings;
+
+use Test::More;
+eval "use Test::Pod 1.00";
+plan skip_all => "Test::Pod 1.00 required for testing POD" if $@;
+all_pod_files_ok('LedgerSMB.pm', all_pod_files('LedgerSMB'));
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.