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

List:       kde-commits
Subject:    KDE/kdelibs/phonon (silent)
From:       Matthias Kretz <kretz () kde ! org>
Date:       2006-03-22 9:59:04
Message-ID: 1143021544.067120.4816.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 521303 by mkretz:

SVN_SILENT: dox for enum values


 M  +20 -0     phononnamespace.h  


--- trunk/KDE/kdelibs/phonon/phononnamespace.h #521302:521303
@@ -34,6 +34,8 @@
  * Phonon::Ifaces.
  *
  * \author Matthias Kretz <kretz@kde.org>
+ *
+ * \see Phonon::Ui
  */
 namespace Phonon
 {
@@ -90,10 +92,28 @@
 	 */
 	enum Category
 	{
+		/**
+		 * No application should use that category - it's the default, though.
+		 */
 		UnspecifiedCategory,
+		/**
+		 * If the sounds produced are notifications (bing, beep and such) you
+		 * should use this category.
+		 */
 		NotificationCategory,
+		/**
+		 * If your application is a music player (like a jukebox or media player
+		 * playing an audio file).
+		 */
 		MusicCategory,
+		/**
+		 * If the sound is the audio channel of a video.
+		 */
 		VideoCategory,
+		/**
+		 * If your applications produces sounds from communication with somebody
+		 * else (VoIP, voice chat).
+		 */
 		CommunicationCategory
 	};
 
[prev in list] [next in list] [prev in thread] [next in thread]