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

List:       kde-commits
Subject:    KDE/kdelibs/phonon
From:       Matthias Kretz <kretz () kde ! org>
Date:       2006-12-11 17:04:24
Message-ID: 1165856664.261452.13356.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 612499 by mkretz:

DOX: remove Ifaces references and fix \copydoc


 M  +103 -90   factory.h  


--- trunk/KDE/kdelibs/phonon/factory.h #612498:612499
@@ -33,9 +33,9 @@
  * \internal
  * \brief Factory to access the preferred Backend.
  *
- * This class is used internally to get the backend's implementation of the
- * Ifaces interfaces. It keeps track of the objects that were created. When a
- * request for a backend changes comes it asks all frontend objects to delete
+ * This class is used internally to get the backend's implementation.
+ * It keeps track of the objects that were created. When a
+ * request for a backend change comes, it asks all frontend objects to delete
  * their backend objects and then checks whether they were all deleted. Only
  * then the old backend is unloaded and the new backend is loaded.
  *
@@ -57,103 +57,116 @@
 		 */
 		static Factory* self();
 
-		/**
-		 * Create a new Ifaces::MediaObject.
-		 *
-		 * \return a pointer to the Ifaces::MediaObject the backend provides
-		 */
-		QObject* createMediaObject( QObject* parent = 0 );
-		/**
-		 * Create a new Ifaces::MediaQueue.
-		 *
-		 * \return a pointer to the Ifaces::MediaQueue the backend provides
-		 */
-		QObject* createMediaQueue( QObject* parent = 0 );
-		/**
-		 * Create a new Ifaces::AvCapture.
-		 *
-		 * \return a pointer to the Ifaces::AvCapture the backend provides
-		 */
-		QObject* createAvCapture( QObject* parent = 0 );
-		/**
-		 * Create a new Ifaces::ByteStream.
-		 *
-		 * \return a pointer to the Ifaces::ByteStream the backend provides
-		 */
-		QObject* createByteStream( QObject* parent = 0 );
+        /**
+         * Create a new backend object for a MediaObject.
+         *
+         * \return a pointer to the MediaObject the backend provides.
+         */
+        QObject* createMediaObject(QObject *parent = 0);
+        /**
+         * Create a new backend object for a MediaQueue.
+         *
+         * \return a pointer to the MediaQueue the backend provides.
+         */
+        QObject* createMediaQueue(QObject *parent = 0);
+        /**
+         * Create a new backend object for a AvCapture.
+         *
+         * \return a pointer to the AvCapture the backend provides.
+         */
+        QObject* createAvCapture(QObject *parent = 0);
+        /**
+         * Create a new backend object for a ByteStream.
+         *
+         * \return a pointer to the ByteStream the backend provides.
+         */
+        QObject* createByteStream(QObject *parent = 0);
 
-		/**
-		 * Create a new Ifaces::AudioPath.
-		 *
-		 * \return a pointer to the Ifaces::AudioPath the backend provides
-		 */
-		QObject* createAudioPath( QObject* parent = 0 );
-		/**
-		 * Create a new Ifaces::AudioEffect.
-		 *
-		 * \return a pointer to the Ifaces::AudioEffect the backend provides
-		 */
-		QObject* createAudioEffect( int effectId, QObject* parent = 0 );
-		/**
-		 * Create a new Ifaces::VolumeFaderEffect.
-		 *
-		 * \return a pointer to the Ifaces::VolumeFaderEffect the backend provides
-		 */
-		QObject* createVolumeFaderEffect( QObject* parent = 0 );
-		/**
-		 * Create a new Ifaces::AudioOutput.
-		 *
-		 * \return a pointer to the Ifaces::AudioOutput the backend provides
-		 */
-		QObject* createAudioOutput( QObject* parent = 0 );
-		/**
-		 * Create a new Ifaces::AudioDataOutput.
-		 *
-		 * \return a pointer to the Ifaces::AudioDataOutput the backend provides
-		 */
-		QObject* createAudioDataOutput( QObject* parent = 0 );
+        /**
+         * Create a new backend object for a AudioPath.
+         *
+         * \return a pointer to the AudioPath the backend provides.
+         */
+        QObject* createAudioPath(QObject *parent = 0);
+        /**
+         * Create a new backend object for a AudioEffect.
+         *
+         * \return a pointer to the AudioEffect the backend provides.
+         */
+        QObject* createAudioEffect(int effectId, QObject *parent = 0);
+        /**
+         * Create a new backend object for a VolumeFaderEffect.
+         *
+         * \return a pointer to the VolumeFaderEffect the backend provides.
+         */
+        QObject* createVolumeFaderEffect(QObject *parent = 0);
+        /**
+         * Create a new backend object for a AudioOutput.
+         *
+         * \return a pointer to the AudioOutput the backend provides.
+         */
+        QObject* createAudioOutput(QObject *parent = 0);
+        /**
+         * Create a new backend object for a AudioDataOutput.
+         *
+         * \return a pointer to the AudioDataOutput the backend provides.
+         */
+        QObject* createAudioDataOutput(QObject *parent = 0);
 
-		/**
-		 * Create a new Ifaces::Visualization.
-		 *
-		 * \return a pointer to the Ifaces::Visualization the backend provides
-		 */
-		QObject* createVisualization( QObject* parent = 0 );
+        /**
+         * Create a new backend object for a Visualization.
+         *
+         * \return a pointer to the Visualization the backend provides.
+         */
+        QObject* createVisualization(QObject *parent = 0);
 
-		/**
-		 * Create a new Ifaces::VideoPath.
-		 *
-		 * \return a pointer to the Ifaces::VideoPath the backend provides
-		 */
-		QObject* createVideoPath( QObject* parent = 0 );
-		/**
-		 * Create a new Ifaces::VideoEffect.
-		 *
-		 * \return a pointer to the Ifaces::VideoEffect the backend provides
-		 */
-		QObject* createVideoEffect( int effectId, QObject* parent = 0 );
-		QObject* createBrightnessControl( QObject* parent = 0 );
-		/**
-		 * Create a new Ifaces::VideoDataOutput.
-		 *
-		 * \return a pointer to the Ifaces::VideoDataOutput the backend provides
-		 */
-		QObject* createVideoDataOutput( QObject* parent = 0 );
+        /**
+         * Create a new backend object for a VideoPath.
+         *
+         * \return a pointer to the VideoPath the backend provides.
+         */
+        QObject* createVideoPath(QObject *parent = 0);
+        /**
+         * Create a new backend object for a VideoEffect.
+         *
+         * \return a pointer to the VideoEffect the backend provides.
+         */
+        QObject* createVideoEffect(int effectId, QObject *parent = 0);
+        /**
+         * Create a new backend object for a BrightnessControl.
+         *
+         * \return a pointer to the BrightnessControl the backend provides.
+         */
+        QObject* createBrightnessControl(QObject *parent = 0);
+        /**
+         * Create a new backend object for a VideoDataOutput.
+         *
+         * \return a pointer to the VideoDataOutput the backend provides.
+         */
+        QObject* createVideoDataOutput(QObject *parent = 0);
 
 		/**
 		 * \return a pointer to the backend interface.
 		 */
 		QObject* backend( bool createWhenNull = true );
 
-		/**
-		 * \copydoc Phonon::Ifaces::Backend::uiLibrary()
-		 */
-		const char* uiLibrary();
-		/**
-		 * \copydoc Phonon::Ifaces::Backend::uiSymbol()
-		 */
-		const char* uiSymbol();
+        /**
+         * \returns The name of the library that needs to be loaded to get access to the
+         * GUI dependent classes.
+         *
+         * \see \ref phonon_UiBackend
+         */
+        const char* uiLibrary();
 
+        /**
+         * This method is useful if you want to put the GUI dependent and GUI indepentend
+         * classes into the same DSO. Then \ref phonon_Backend_uiLibrary "uiLibrary()"
+         * returns the same library as is specified in the .desktop file.
+         * \returns The symbol in the library that needs to be called to get access to the
+         * \ref phonon_UiBackend "UiBackend" instance.
+         */
+        const char* uiSymbol();
+
 		/**
 		 * Get the name of the Backend. It's the name from the .desktop file.
 		 */
[prev in list] [next in list] [prev in thread] [next in thread]