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
@@ -34,2 +34,10 @@
 
+/*!
+  \class TimeZoneSelector
+
+  \brief The TimeZoneSelector widget allows users to configure their time zone information.
+
+  \ingroup qtopiaemb
+*/
+
 class TimeZoneSelectorPrivate
@@ -195,2 +203,6 @@ 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.
+*/
 
@@ -215,2 +227,5 @@ TimeZoneSelector::TimeZoneSelector(QWidget* p, const char* n) :
 
+/*!
+  Destroys a TimeZoneSelector.
+*/
 TimeZoneSelector::~TimeZoneSelector()
@@ -230,3 +245,6 @@ 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
@@ -236,2 +254,5 @@ QString TimeZoneSelector::currentZone() const
 
+/*!
+  Sets the current timezone to \a id.
+*/
 void TimeZoneSelector::setCurrentZone( const QString& id )
@@ -240,2 +261,7 @@ void TimeZoneSelector::setCurrentZone( const QString& 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
+*/
+
 
@@ -248,3 +274,3 @@ void TimeZoneSelector::slotExecute( void )
 {
-  // execute the world time application...  
+  // execute the world time application...
   if (QFile::exists(QPEApplication::qpeDir()+"bin/citytime"))
@@ -272,3 +298,3 @@ QStringList timezoneDefaults( void )
     tzs.append( "Denver" );
-    
+
     return tzs;