[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    kdelibs/arts/kde
From:       Arnold Krille <arnold () arnoldarts ! de>
Date:       2003-09-04 14:58:01
[Download RAW message or body]

CVS commit by akrille: 

Some documentation


  M +9 -1      kaudioplaystream.h   1.3
  M +6 -0      kaudiorecordstream.h   1.7


--- kdelibs/arts/kde/kaudioplaystream.h  #1.2:1.3
@@ -31,4 +31,11 @@ namespace Arts { class StereoEffectStack
 class KAudioPlayStreamPrivate;
 
+/**
+ * @brief A wrapper around ByteSoundProducer/ByteStreamToAudio/Synth_AMAN_PLAY.
+ *
+ * @author Arnold Krille <arnold@arnoldarts.de>
+ * @since 3.2
+*/
+
 class KAudioPlayStream : public QObject {
    Q_OBJECT
@@ -40,4 +47,5 @@ public:
          * @param server The server where it should play to.
          * @param title The title that is shown in the AudioManager.
+         * @param parent You will propably want to pass the server as parent to so \
                this stream gets deleted before the server disappears.
         */
         KAudioPlayStream( KArtsServer* server, const QString title, QObject* \
parent=0, const char* name=0 ); @@ -100,5 +108,5 @@ signals:
 
         /**
-         * Is emitted if the inputbuffer runs dry
+         * Is emitted if the inputbuffer runs dry and polling os off.
         */
         void noData();

--- kdelibs/arts/kde/kaudiorecordstream.h  #1.6:1.7
@@ -31,4 +31,10 @@ class KArtsServer;
 namespace Arts { class StereoEffectStack; }
 
+/**
+ * @brief A KDE wrapper around Synth_AMAN_RECORD/AudioToByteStream/ByteSoundReceiver
+ *
+ * @author Matthias Kretz <kretz@kde.org>
+ * @since 3.2
+*/
 class KAudioRecordStream : public QObject
 {


[prev in list] [next in list] [prev in thread] [next in thread]