[Player-cvs] music/servicekit/pub mmp_service.h,1.13,1.14

[Player-cvs] music/servicekit/pub mmp_service.h,1.13,1.14

cdunn at helixcommunity.org cdunn at helixcommunity.org
Tue Sep 21 17:28:50 PDT 2004


Update of /cvsroot/player/music/servicekit/pub
In directory cvs-new:/tmp/cvs-serv24037/pub

Modified Files:
	mmp_service.h 
Log Message:
Add documentation for global typedef enums

Index: mmp_service.h
===================================================================
RCS file: /cvsroot/player/music/servicekit/pub/mmp_service.h,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14
--- mmp_service.h	21 Sep 2004 23:39:55 -0000	1.13
+++ mmp_service.h	22 Sep 2004 00:28:48 -0000	1.14
@@ -42,24 +42,26 @@
 #include "mmp_library_track.h"
 #include "mmp_httpclient.h"
 
-/** 
- * Meta data type enumerator.
+/** @addtogroup GlobalTypes Global Types */
+//@{
+/** Meta data type enumerator. Used for retrieving and setting meta data elements.
+ * @see CMmpService
  */
 typedef enum {
-    kServiceTrack = 0,
-    kServiceAlbum,
-    kServiceArtist,
-    kServiceArtistBio,
-    kServiceArtistImageURL,
-    kServiceArtistImageLocation,
-    kServiceSimilarContemporary,
-    kServiceSimilarFollowing,
-    kServiceSimilarInfluencing,
-    kServiceAlbumArtURL,
-    kServiceAlbumArtLocation,
-    kServiceAlbumReview,
-    kServiceAlbumTrackID,
-    kServiceAlbumTrackName
+    kServiceTrack = 0, 		///< Track name
+    kServiceAlbum,		///< Album name
+    kServiceArtist,		///< Artist name
+    kServiceArtistBio,		///< Artist biography
+    kServiceArtistImageURL,	///< Artist image URL
+    kServiceArtistImageLocation,///< Artist image local location
+    kServiceSimilarContemporary,///< Similar contemporary artists
+    kServiceSimilarFollowing,	///< Similar following artists
+    kServiceSimilarInfluencing,	///< Similar influences
+    kServiceAlbumArtURL,	///< Album image URL
+    kServiceAlbumArtLocation,	///< Album image local location
+    kServiceAlbumReview,	///< Album review
+    kServiceAlbumTrackID,	///< Album track ID
+    kServiceAlbumTrackName	///< Album track name
 } HxServiceData;
 
 /** State of meta data retrieval.
@@ -67,12 +69,13 @@
  * then the artist image.
  */
 typedef enum {
-    kServiceStateInitial,
-    kServiceStateWaitingForXML,
-    kServiceStateWaitingForAlbumArt,
-    kServiceStateWaitingForArtistArt,
-    kServiceStateDone
+    kServiceStateInitial,		///< Initial state of meta data download
+    kServiceStateWaitingForXML,		///< Currently downloading XML data
+    kServiceStateWaitingForAlbumArt,	///< Currently downloading album image
+    kServiceStateWaitingForArtistArt,	///< Currently downloading artist image
+    kServiceStateDone			///< All meta has been downloaded
 } HxServiceState;
+//@}
 
 /**
  * Observer class for CMmpService




More information about the Player-cvs mailing list
 

Site Map   |   Terms of Use   |   Privacy Policy   |   Contact Us

Copyright © 1995-2007 RealNetworks, Inc. All rights reserved. RealNetworks and Helix are trademarks of RealNetworks.
All other trademarks or registered trademarks are the property of their respective holders.