Update the API Documentation for DateFormat and TimeString utility classes

Add a Translator hint what M, D, Y mean

1 files changed, 2 insertions, 2 deletions

diff --git a/library/timestring.cpp b/library/timestring.cpp
index 8f60b72..2fd0191 100644
--- a/library/timestring.cpp
+++ b/library/timestring.cpp
@@ -6,132 +6,132 @@
 ** This file may be distributed and/or modified under the terms of the
 ** GNU General Public License version 2 as published by the Free Software
 ** Foundation and appearing in the file LICENSE.GPL included in the
 ** packaging of this file.
 **
 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 **
 ** See http://www.trolltech.com/gpl/ for GPL licensing information.
 **
 ** Contact info@trolltech.com if any conditions of this licensing are
 ** not clear to you.
 **
 **********************************************************************/
 
 #include "timestring.h"
 #include <qobject.h>
 #include <qpe/qpeapplication.h> //for qApp
 #include "config.h"
 
 
 class TimeStringFormatKeeper : public QObject
 {
     Q_OBJECT
 public:
     static DateFormat currentFormat()
     {
 	if ( !self )
 	    self  = new TimeStringFormatKeeper;
 	return self->format;
     }
 private slots:
     void formatChanged( DateFormat f )
     {
 	format = f;
     }
 private:
     static TimeStringFormatKeeper *self;
     DateFormat format;
 
     TimeStringFormatKeeper()
 	: QObject( qApp )
     {
 	Config config("qpe");
 	config.setGroup( "Date" );
 	format = DateFormat(QChar(config.readEntry("Separator", "/")[0]),
 		(DateFormat::Order)config .readNumEntry("ShortOrder", DateFormat::DayMonthYear),
 		(DateFormat::Order)config.readNumEntry("LongOrder", DateFormat::DayMonthYear));
 
 	connect( qApp, SIGNAL( dateFormatChanged(DateFormat) ),
 		 this, SLOT( formatChanged( DateFormat ) ) );
     }
 };
 
 TimeStringFormatKeeper *TimeStringFormatKeeper::self = 0;
 
 QString DateFormat::toNumberString() const
 {
     QString buf = "";
     // for each part of the order
     for (int i = 0; i < 3; i++) {
 	// switch on the relavent 3 bits.
 	switch((_shortOrder >> (i * 3)) & 0x0007) {
 	    case 0x0001:
-		buf += QObject::tr( "D" );
+		buf += QObject::tr( "D" , "Shortcut for Day");
 		break;
 	    case 0x0002:
-		buf += QObject::tr( "M" );
+		buf += QObject::tr( "M", "Shortcur for Month" );
 		break;
 	    case 0x0004:
 		buf += QObject::tr( "Y" );
 		break;
 	}
 	if (i < 2)
 	    buf += _shortSeparator;
     }
     return buf;
 }
 
 QString DateFormat::toWordString() const
 {
     QString buf = "";
     // for each part of the order
     for (int i = 0; i < 3; i++) {
 	// switch on the relavent 3 bits.
 	switch((_longOrder >> (i * 3)) & 0x0007) {
 	    case 0x0001:
 		buf += QObject::tr( "day" );
 		if (i < 2) {
 		    if ((_shortOrder << ((i+1) * 3)) & 0x0007)
 			buf += ", ";
 		    else
 			buf += " ";
 		}
 		break;
 	    case 0x0002:
 		buf += QObject::tr( "month" );
 		if (i < 2)
 		    buf += " ";
 		break;
 	    case 0x0004:
 		buf += QObject::tr( "year" );
 		if (i < 2)
 		    buf += ", ";
 		break;
 	}
     }
     return buf;
 }
 
 QString DateFormat::numberDate(const QDate &d, int v) const
 {
     QString buf = "";
 
     int pad = 2;
 
     // for each part of the order
     for (int i = 0; i < 3; i++) {
 	// switch on the relavent 3 bits.
 	switch((_shortOrder >> (i * 3)) & 0x0007) {
 	    case 0x0001:
 	      if (pad==2) buf += QString().sprintf("%02d",d.day());
 	      else buf += QString().sprintf("%d",d.day());
 		break;
 	    case 0x0002:
 	      if (i==0) { // no padding with only MM/DD/YY format
 		pad=0;
 	      }
 	      if (pad==2) buf += QString().sprintf("%02d",d.month());
 	      else buf += QString().sprintf("%d",d.month());
 		break;
 	    case 0x0004: