Merged branches from BRANCH_1_0

1 files changed, 29 insertions, 3 deletions

diff --git a/library/tzselect.cpp b/library/tzselect.cpp
index 335037e..4343eab 100644
--- a/library/tzselect.cpp
+++ b/library/tzselect.cpp
@@ -33,4 +33,12 @@
 #include <qmessagebox.h>
 
+/*!
+  \class TimeZoneSelector
+
+  \brief The TimeZoneSelector widget allows users to configure their time zone information.
+
+  \ingroup qtopiaemb
+*/
+
 class TimeZoneSelectorPrivate
 {
@@ -194,4 +202,8 @@ void TZCombo::handleSystemChannel(const QCString&msg, const QByteArray&)
 }
 
+/*!
+    Creates a new TimeZoneSelector with parent \a p and name \a n.  The combobox will be
+    populated with the available timezones.
+*/
 
 TimeZoneSelector::TimeZoneSelector(QWidget* p, const char* n) :
@@ -214,4 +226,7 @@ TimeZoneSelector::TimeZoneSelector(QWidget* p, const char* n) :
 }
 
+/*!
+  Destroys a TimeZoneSelector.
+*/
 TimeZoneSelector::~TimeZoneSelector()
 {
@@ -229,5 +244,8 @@ bool TimeZoneSelector::localIncluded() const
 }
 
-
+/*!
+  Returns the currently selected timezone as a string in location format, e.g.
+  \code Australia/Brisbane \endcode
+*/
 QString TimeZoneSelector::currentZone() const
 {
@@ -235,8 +253,16 @@ QString TimeZoneSelector::currentZone() const
 }
 
+/*!
+  Sets the current timezone to \a id.
+*/
 void TimeZoneSelector::setCurrentZone( const QString& id )
 {
     cmbTz->setCurrZone( id );
 }
+/*! \fn void TimeZoneSelector::signalNewTz( const QString& id )
+  This signal is emitted when a timezone has been selected by the user. The id
+  is a \l QString in location format, eg \code Australia/Brisbane \endcode
+*/
+
 
 void TimeZoneSelector::slotTzActive( int )
@@ -247,5 +273,5 @@ void TimeZoneSelector::slotTzActive( int )
 void TimeZoneSelector::slotExecute( void )
 {
-  // execute the world time application...  
+  // execute the world time application...
   if (QFile::exists(QPEApplication::qpeDir()+"bin/citytime"))
     Global::execute( "citytime" );
@@ -271,5 +297,5 @@ QStringList timezoneDefaults( void )
     tzs.append( "America/Denver" );
     tzs.append( "Denver" );
-    
+
     return tzs;
 }