fix bug 0001185

and state that syncing system time depends on AlarmServer
using atd or opie-alarm

2 files changed, 17 insertions, 12 deletions

diff --git a/library/alarmserver.cpp b/library/alarmserver.cpp
index 2ea4025..a75fc7e 100644
--- a/library/alarmserver.cpp
+++ b/library/alarmserver.cpp
@@ -303,33 +303,33 @@ void TimerReceiverObject::timerEvent( QTimerEvent * )
 
 /*!
   \class AlarmServer alarmserver.h
   \brief The AlarmServer class allows alarms to be scheduled and unscheduled.
- 
+
     Applications can schedule alarms with addAlarm() and can
     unschedule alarms with deleteAlarm(). When the time for an alarm
     to go off is reached the specified \link qcop.html QCop\endlink
     message is sent on the specified channel (optionally with
     additional data).
- 
+
     Scheduling an alarm using this class is important (rather just using
     a QTimer) since the machine may be asleep and needs to get woken up using
     the Linux kernel which implements this at the kernel level to minimize
     battery usage while asleep.
- 
+
     \ingroup qtopiaemb
     \sa QCopEnvelope
 */
 
 /*!
   Schedules an alarm to go off at (or soon after) time \a when. When
   the alarm goes off, the \link qcop.html QCop\endlink \a message will
   be sent to \a channel, with \a data as a parameter.
- 
+
   If this function is called with exactly the same data as a previous
   call the subsequent call is ignored, so there is only ever one alarm
   with a given set of parameters.
- 
+
   \sa deleteAlarm()
 */
 void AlarmServer::addAlarm ( QDateTime when, const QCString& channel,
                              const QCString& message, int data)
@@ -380,17 +380,17 @@ void AlarmServer::addAlarm ( QDateTime when, const QCString& channel,
 
 /*!
   Deletes previously scheduled alarms which match \a when, \a channel,
   \a message, and \a data.
- 
+
   Passing null values for \a when, \a channel, or for the \link
   qcop.html QCop\endlink \a message, acts as a wildcard meaning "any".
   Similarly, passing -1 for \a data indicates "any".
- 
+
   If there is no matching alarm, nothing happens.
- 
+
   \sa addAlarm()
- 
+
 */
 void AlarmServer::deleteAlarm (QDateTime when, const QCString& channel, const QCString& message, int data)
 {
 	if ( qApp->type() == QApplication::GuiServer) {
@@ -433,9 +433,12 @@ void AlarmServer::deleteAlarm (QDateTime when, const QCString& channel, const QC
 	}
 }
 
 /*!
-  Writes the system clock to the hardware clock.
+  The implementation depends on the mode of AlarmServer. If the AlarmServer
+  uses atd the current system time will be written to the hardware clock.
+  If the AlarmServer relies on opie-alarm the time will be written once the
+  device gets suspended. opie-alarm is used by the Zaurus, iPAQs and SIMpad
 */
 void Global::writeHWClock()
 {
 #ifdef USE_ATD
diff --git a/library/global.cpp b/library/global.cpp
index 5c89430..90954fe 100644
--- a/library/global.cpp
+++ b/library/global.cpp
@@ -212,10 +212,12 @@ static QString dictDir()
   characters.
 
   \section1 Hardware
 
-  The writeHWClock() function sets the hardware clock to the system
-  clock's date and time.
+  The implementation of the writeHWClock() function depends on the AlarmServer
+  implementation. If the AlarmServer is using atd the clock will be synced to
+  hardware. If opie-alarm is used the hardware clock will be synced before
+  suspending the device. opie-alarm is used by iPAQ and Zaurii implementation
 
   \ingroup qtopiaemb
 */