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
@@ -306,3 +306,3 @@ void TimerReceiverObject::timerEvent( QTimerEvent * )
   \brief The AlarmServer class allows alarms to be scheduled and unscheduled.
- 
+
     Applications can schedule alarms with addAlarm() and can
@@ -312,3 +312,3 @@ void TimerReceiverObject::timerEvent( QTimerEvent * )
     additional data).
- 
+
     Scheduling an alarm using this class is important (rather just using
@@ -317,3 +317,3 @@ void TimerReceiverObject::timerEvent( QTimerEvent * )
     battery usage while asleep.
- 
+
     \ingroup qtopiaemb
@@ -326,3 +326,3 @@ void TimerReceiverObject::timerEvent( QTimerEvent * )
   be sent to \a channel, with \a data as a parameter.
- 
+
   If this function is called with exactly the same data as a previous
@@ -330,3 +330,3 @@ void TimerReceiverObject::timerEvent( QTimerEvent * )
   with a given set of parameters.
- 
+
   \sa deleteAlarm()
@@ -383,3 +383,3 @@ void AlarmServer::addAlarm ( QDateTime when, const QCString& channel,
   \a message, and \a data.
- 
+
   Passing null values for \a when, \a channel, or for the \link
@@ -387,7 +387,7 @@ void AlarmServer::addAlarm ( QDateTime when, const QCString& channel,
   Similarly, passing -1 for \a data indicates "any".
- 
+
   If there is no matching alarm, nothing happens.
- 
+
   \sa addAlarm()
- 
+
 */
@@ -436,3 +436,6 @@ 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
 */
diff --git a/library/global.cpp b/library/global.cpp
index 5c89430..90954fe 100644
--- a/library/global.cpp
+++ b/library/global.cpp
@@ -215,4 +215,6 @@ static QString dictDir()
 
-  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