Update Opie Documentation

1 files changed, 59 insertions, 3 deletions

diff --git a/libopie2/opiecore/device/odevice.cpp b/libopie2/opiecore/device/odevice.cpp
index 2b10034..ec861ee 100644
--- a/libopie2/opiecore/device/odevice.cpp
+++ b/libopie2/opiecore/device/odevice.cpp
@@ -346,4 +346,9 @@ bool ODevice::setDisplayBrightness ( int p)
 /**
-* @return returns the number of steppings on the brightness slider
-* in the Light-'n-Power settings.
+ * 
+ * @return Returns the number of steppings on the brightness slider
+ * in the Light-'n-Power settings. Values smaller zero and bigger
+ * than 255 do not make sense.
+ *
+ * \sa QSlider::setLineStep
+ * \sa QSlider::setPageStep
 */
@@ -713,2 +718,6 @@ void ODevice::remapHeldAction ( int button, const OQCopMessage &action )
 }
+
+/**
+ * @internal
+ */
 void ODevice::virtual_hook(int, void* ){
@@ -718,5 +727,11 @@ void ODevice::virtual_hook(int, void* ){
 /**
+ * \brief Send a QCOP Message before suspending
+ *
  * Sends a QCOP message to channel QPE/System
  * with the message "aboutToSuspend()" if this
- * is the windowing server
+ * is the windowing server.
+ * 
+ * Call this in your custom \sa suspend() Method
+ * before going to suspend.
+ * 
  */
@@ -760,2 +775,8 @@ void ODevice::remPreHandler(QWSServer::KeyboardFilter*aFilter)
 
+
+/**
+ * @internal
+ * 
+ * @see changeMixerForAlarm
+ */
 void ODevice::playingStopped() {
@@ -770,2 +791,37 @@ void ODevice::playingStopped() {
 
+
+/**
+ * \brief Change the Volume for the Alarm and set it back after playing is finished
+ *
+ * If you play an Alarm Sound you might want to change the Mixer to
+ * full volume and ignore the user setting. After it \sa Sound::isFinished
+ * you would turn the volume back to the user preference.
+ * The problem is that we used to enter the event loop while waiting
+ * for the sound to be finished triggering all kind of reentrance
+ * problems what a library shouldn't introduce.
+ * Instead of manually waiting for the sound to be finished use
+ * this Method and it will automatically restore the Mixer to
+ * the user configuration after the sound finished playing.
+ *
+ * Note: The onwership of \param snd is not transfered and playing
+ * is not started in this method. If 'snd' gets deleted before
+ * playing is finished the volume doesn't get set back to
+ * the user preference!
+ *
+ * \code
+ * static Sound snd("alarm");
+ * if(!snd.isFinished())
+ *    return;
+ *
+ * changeMixerForAlarm( my_channel, "/dev/mixer", &snd );
+ * snd.play()
+ * \endcode
+ * 
+ * 
+ *
+ * @param mixer The mixer number/channel to use
+ * @param file  The file name. If you convert from QString use QFile::encodeName
+ * @param snd   The sound to wait for finishing
+ * 
+ */
 void ODevice::changeMixerForAlarm( int mixer, const char* file, Sound *snd ) {