[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    KDE/kdelibs/kdecore
From:       David Jarvie <software () astrojar ! org ! uk>
Date:       2005-10-26 18:33:52
Message-ID: 1130351632.243739.32530.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 474564 by djarvie:

Tidy up comments and add short descriptors


 M  +0 -1      ktimezones.cpp  
 M  +10 -2     ktimezones.h  
 M  +0 -8      ktzfiletimezone.cpp  
 M  +3 -1      ktzfiletimezone.h  


--- trunk/KDE/kdelibs/kdecore/ktimezones.cpp #474563:474564
@@ -986,7 +986,6 @@
     int offset1 = (t == (time_t)-1) ? 0 : gmtoff(t);
     if (secondOffset)
     {
-#warning Check secondOffset works
         int offset2 = offset1;
         if (t != (time_t)-1)
         {
--- trunk/KDE/kdelibs/kdecore/ktimezones.h #474563:474564
@@ -47,7 +47,7 @@
 class KSystemTimezoneSourcePrivate;
 class KSystemTimezoneDataPrivate;
 
-/** @defgroup timezones Timezone classes
+/** @defgroup timezones Time zone classes
  *
  * The time zone classes provide a framework for accessing time zone data, and
  * converting times and dates between different time zones. They provide access
@@ -125,6 +125,7 @@
  *
  * If you want to access system time zones, use the KSystemTimezones class.
  *
+ * @short Represents a time zone database or collection
  * @ingroup timezones
  * @author David Jarvie <software@astrojar.org.uk>.
  * @author S.R.Haque <srhaque@iee.org>.
@@ -228,6 +229,7 @@
  * part of such a collection, it is owned by the KTimezones instance and should not be
  * deleted.
  *
+ * @short Base class representing a time zone
  * @see KTimezoneSource, KTimezoneData
  * @ingroup timezones
  * @author David Jarvie <software@astrojar.org.uk>.
@@ -464,6 +466,7 @@
  * KTimezoneSource itself may be used as a dummy source which returns empty
  * time zone details.
  *
+ * @short Base class representing a source of time zone information
  * @see KTimezone, KTimezoneData
  * @ingroup timezones
  * @author David Jarvie <software@astrojar.org.uk>.
@@ -497,6 +500,7 @@
  *
  * This base class can be instantiated, but contains no data.
  *
+ * @short Base class for parsed time zone data
  * @see KTimezone, KTimezoneSource
  * @ingroup timezones
  * @author David Jarvie <software@astrojar.org.uk>.
@@ -562,6 +566,7 @@
  * QDateTime omaniTime = local->convert(oman, sampleTime);
  * \endcode
  *
+ * @short System time zone access
  * @see KTimezones, KSystemTimezone, KSystemTimezoneSource
  * @ingroup timezones
  * @author David Jarvie <software@astrojar.org.uk>.
@@ -631,6 +636,7 @@
  *
  * Typically, instances are created and accessed via the KSystemTimezones class.
  *
+ * @short System time zone
  * @see KSystemTimezones, KSystemTimezoneSource, KSystemTimezoneData
  * @ingroup timezones
  * @author David Jarvie <software@astrojar.org.uk>.
@@ -692,6 +698,7 @@
  *
  * Access is performed via the system time zone library functions.
  *
+ * @short Reads and parses system time zone data
  * @see KSystemTimezones, KSystemTimezone, KSystemTimezoneData
  * @ingroup timezones
  * @author David Jarvie <software@astrojar.org.uk>.
@@ -740,8 +747,9 @@
 
 
 /**
- * The parsed time zone data returned by KSystemTimezoneSource.
+ * The parsed system time zone data returned by KSystemTimezoneSource.
  *
+ * @short Parsed system time zone data
  * @see KSystemTimezoneSource, KSystemTimezone
  * @ingroup timezones
  * @author David Jarvie <software@astrojar.org.uk>.
--- trunk/KDE/kdelibs/kdecore/ktzfiletimezone.cpp #474563:474564
@@ -19,17 +19,9 @@
 
 #include <config.h>
 
-//#include <cmath>
-//#include <climits>
-//#include <cstdlib>
-
 #include <QFile>
 #include <QDataStream>
 
-//#include <kcodecs.h>
-//#include <kprocess.h>
-//#include <kstringhandler.h>
-//#include <ktempfile.h>
 #include <kdebug.h>
 #include <ktzfiletimezone.h>
 
--- trunk/KDE/kdelibs/kdecore/ktzfiletimezone.h #474563:474564
@@ -25,7 +25,6 @@
 #ifndef _KTZFILETIMEZONE_H
 #define _KTZFILETIMEZONE_H
 
-//#include <ctime>
 #include <QDateTime>
 #include <QList>
 #include <QString>
@@ -44,6 +43,7 @@
  * It works in partnership with the KTzfileTimezoneSource class which reads and parses the
  * time zone definition files.
  *
+ * @short Represents a time zone defined in tzfile(5) format
  * @see KTzfileTimezoneSource, KTzfileTimezoneData
  * @ingroup timezones
  * @author David Jarvie <software@astrojar.org.uk>.
@@ -123,6 +123,7 @@
  * tzfile is the format used by zoneinfo files in the system time zone database.
  * The format is documented in the tzfile(5) manpage.
  *
+ * @short Reads and parses tzfile(5) time zone definition files
  * @see KTzfileTimezone, KTzfileTimezoneData
  * @ingroup timezones
  * @author David Jarvie <software@astrojar.org.uk>.
@@ -164,6 +165,7 @@
 /**
  * The parsed data returned by KTzfileTimezoneSource.
  *
+ * @short Parsed data from tzfile(5) time zone definition files
  * @see KTzfileTimezoneSource, KTzfileTimezone
  * @ingroup timezones
  * @author David Jarvie <software@astrojar.org.uk>.
[prev in list] [next in list] [prev in thread] [next in thread]