SF.net SVN: ledger-smb: [1217] branches/1.2/LedgerSMB/Locale.pm

[..hidden..]

Revision: 1217
          http://svn.sourceforge.net/ledger-smb/?rev=1217&view=rev
Author:   tetragon
Date:     2007-05-19 15:00:22 -0700 (Sat, 19 May 2007)

Log Message:
-----------
Documentation update for $locale->date

Modified Paths:
--------------
    branches/1.2/LedgerSMB/Locale.pm

Modified: branches/1.2/LedgerSMB/Locale.pm
===================================================================
--- branches/1.2/LedgerSMB/Locale.pm	2007-05-19 22:00:01 UTC (rev 1216)
+++ branches/1.2/LedgerSMB/Locale.pm	2007-05-19 22:00:22 UTC (rev 1217)
@@ -1,3 +1,4 @@
+
 =head1 NAME
 
 LedgerSMB::Locale  Locale handling class for LedgerSMB
@@ -9,18 +10,25 @@
 =head1 METHODS
 
 =item get_handle ($language_code)
+
 Returns a locale handle for accessing the other methods.  Inherited from 
 Locale::Maketext.
 
 =item text ($string)
+
 Returns the translation for the given string.  This is a legacy wrapper that
 merely calls $self->maketext.
 
 =item date ($myconfig, $date, $longformat)
-Returns the given date after formatting it.  If $longformat is set, the date 
-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}.
 
+Returns the given date after formatting it.  $longformat is a ternary flag that
+determines how the date is formatted.  If $longformat is true, the date will be
+given in the form of "_('September') 23 2007".  If $longformat is false but
+defined, the date will be in the form of "_('Sep') 23 2007" unless the date is
+given in the form 'yyyy.mm.dd', in which case it is returned as-is.  If
+$longformat is not defined, the date will be output in the format specified by
+$myconfig->{dateformat}.
+
 =head1 Copyright (C) 2006, The LedgerSMB core team.
 
 #=====================================================================
@@ -60,6 +68,7 @@
 =cut
 
 package LedgerSMB::Locale;
+
 use base 'Locale::Maketext';
 use Locale::Maketext::Lexicon;
 use Encode;


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