Documentation: mark functions added in 0.4.0

6 files changed, 101 insertions, 29 deletions

diff --git a/src/itdb.h b/src/itdb.h
index 5563fe3..849605d 100644
--- a/src/itdb.h
+++ b/src/itdb.h
@@ -119,6 +119,8 @@ typedef struct _Itdb_Chapterdata Itdb_Chapterdata;
  *
  * See http://support.apple.com/kb/HT1353 and http://en.wikipedia.org/wiki/IPod
  * for more details.
+ *
+ * Since: 0.4.0
  */
 typedef enum {
     ITDB_IPOD_GENERATION_UNKNOWN,
@@ -183,6 +185,8 @@ typedef enum {
  * @ITDB_IPOD_MODEL_TOUCH_BLACK:    iPod Touch (Black)
  *
  * iPod model information
+ *
+ * Since: 0.4.0
  */
 typedef enum {
     ITDB_IPOD_MODEL_INVALID,
@@ -244,6 +248,8 @@ typedef enum {
  * @reserved2:       Reserved for future use
  *
  * Structure representing information about an iPod
+ *
+ * Since: 0.4.0
  */
 struct _Itdb_IpodInfo {
     const gchar *model_number;
@@ -882,6 +888,8 @@ struct _Itdb_Artwork {
  * @userdata_destroy:   A function to free #userdata
  *
  * Structure representing an iTunes Photo database
+ *
+ * Since: 0.4.0
  */
 struct _Itdb_PhotoDB
 {
@@ -976,6 +984,8 @@ struct _Itdb_iTunesDB
  * @userdata_destroy:     A function to free #userdata
  *
  * Structure representing an iTunes Photo Album
+ *
+ * Since: 0.4.0
  */
 struct _Itdb_PhotoAlbum
 {
diff --git a/src/itdb_device.c b/src/itdb_device.c
index 79ecd01..64817c8 100644
--- a/src/itdb_device.c
+++ b/src/itdb_device.c
@@ -651,7 +651,9 @@ static void itdb_device_reset_sysinfo (Itdb_Device *device)
  *
  * Return value: a newly allocated #Itdb_Device which must be freed with
  * itdb_device_free() when no longer needed
- **/
+ *
+ * Since: 0.4.0
+ */
 Itdb_Device *itdb_device_new ()
 {
     Itdb_Device *dev;
@@ -666,7 +668,9 @@ Itdb_Device *itdb_device_new ()
  * @device: an #Itdb_Device
  *
  * Frees memory used by @device
- **/
+ *
+ * Since: 0.4.0
+ */
 void itdb_device_free (Itdb_Device *device)
 {
     if (device)
@@ -688,7 +692,9 @@ void itdb_device_free (Itdb_Device *device)
  *
  * Sets the mountpoint of @device to @mp and update the cached device 
  * information (in particular, re-read the SysInfo file)
- **/
+ *
+ * Since: 0.4.0
+ */
 void itdb_device_set_mountpoint (Itdb_Device *device, const gchar *mp)
 {
     g_return_if_fail (device);
@@ -754,7 +760,9 @@ static void itdb_device_read_sysinfo_extended (Itdb_Device *device)
  * later use.
  *
  * Return value: TRUE if file could be read, FALSE otherwise 
- **/
+ *
+ * Since: 0.4.0
+ */
 gboolean itdb_device_read_sysinfo (Itdb_Device *device)
 {
     const gchar *p_sysinfo[] = {"SysInfo", NULL};
@@ -833,7 +841,9 @@ static void write_sysinfo_entry (const gchar *key,
  * no directories are created if not already existent.
  *
  * Return value: TRUE if file could be read, FALSE otherwise 
- **/
+ *
+ * Since: 0.4.0
+ */
 gboolean itdb_device_write_sysinfo (Itdb_Device *device, GError **error)
 {
     gchar *devicedir;
@@ -889,7 +899,9 @@ gboolean itdb_device_write_sysinfo (Itdb_Device *device, GError **error)
  *
  * Return value: the information associated with @field, or NULL if @field
  * couldn't be found. g_free() after use
- **/
+ *
+ * Since: 0.4.0
+ */
 gchar *itdb_device_get_sysinfo (const Itdb_Device *device, const gchar *field)
 {
     g_return_val_if_fail (device, NULL);
@@ -908,7 +920,8 @@ gchar *itdb_device_get_sysinfo (const Itdb_Device *device, const gchar *field)
  * Set specified field. It can later be written to the iPod using
  * itdb_device_write_sysinfo()
  *
- **/
+ * Since: 0.4.0
+ */
 void itdb_device_set_sysinfo (Itdb_Device *device,
 			      const gchar *field, const gchar *value)
 {
@@ -936,7 +949,9 @@ void itdb_device_set_sysinfo (Itdb_Device *device,
  * Retrieve the #Itdb_IpodInfo entry for this iPod
  *
  * Return value: the #Itdb_IpodInfo entry for this iPod
- **/
+ *
+ * Since: 0.4.0
+ */
 const Itdb_IpodInfo *
 itdb_device_get_ipod_info (const Itdb_Device *device)
 {
@@ -1274,7 +1289,9 @@ itdb_device_autodetect_endianess (Itdb_Device *device)
  * which is an array of #Itdb_IpodInfo entries.
  *
  * Return value: a pointer to the array of #Itdb_IpodInfo entries.
- **/
+ *
+ * Since: 0.4.0
+ */
 const Itdb_IpodInfo *itdb_info_get_ipod_info_table (void)
 {
     return &ipod_info_table[2];
@@ -1289,7 +1306,9 @@ const Itdb_IpodInfo *itdb_info_get_ipod_info_table (void)
  *
  * Return value: a pointer to the model name. This is a static string
  * and must not be g_free()d.
- **/
+ *
+ * Since: 0.4.0
+ */
 const gchar *itdb_info_get_ipod_model_name_string (Itdb_IpodModel model)
 {
     gint i=0;
@@ -1314,7 +1333,9 @@ const gchar *itdb_info_get_ipod_model_name_string (Itdb_IpodModel model)
  *
  * Return value: a pointer to the generation name. This is a static
  * string and must not be g_free()d.
- **/
+ *
+ * Since: 0.4.0
+ */
 const gchar *itdb_info_get_ipod_generation_string (Itdb_IpodGeneration generation)
 {
     gint i=0;
diff --git a/src/itdb_device.h b/src/itdb_device.h
index 41af762..f5774e6 100644
--- a/src/itdb_device.h
+++ b/src/itdb_device.h
@@ -89,6 +89,8 @@ enum _ItdbThumbFormat
  *                      and UTC
  *
  * Structure representing an iPod device
+ *
+ * Since: 0.4.0
  */
 struct _Itdb_Device
 {
diff --git a/src/itdb_itunesdb.c b/src/itdb_itunesdb.c
index e98e507..6e62e29 100644
--- a/src/itdb_itunesdb.c
+++ b/src/itdb_itunesdb.c
@@ -5718,7 +5718,9 @@ void itdb_set_mountpoint (Itdb_iTunesDB *itdb, const gchar *mp)
  *
  * Return value: the @itdb mountpoint, this string shouldn't be freed nor 
  * modified
- **/
+ *
+ * Since: 0.4.0
+ */
 const gchar *itdb_get_mountpoint (Itdb_iTunesDB *itdb)
 {
     g_return_val_if_fail (itdb, NULL);
@@ -6325,7 +6327,9 @@ itdb_file_set_contents (const char *filename,
  *
  * Return value: path to the control dir or NULL if non-existent. Must
  * g_free() after use.
- **/
+ *
+ * Since: 0.4.0
+ */
 gchar *itdb_get_control_dir (const gchar *mountpoint)
 {
     gchar *p_ipod[] = {"iPod_Control", NULL};
@@ -6385,7 +6389,9 @@ static gchar *itdb_get_dir (const gchar *mountpoint, const gchar *dir)
  *
  * Return value: path to the @file or NULL if non-existent. Must be g_free()'d 
  * after use.
- **/
+ *
+ * Since: 0.4.0
+ */
 gchar *itdb_get_path (const gchar *dir, const gchar *file)
 {
     const gchar *p_file[] = {NULL, NULL};
@@ -6406,7 +6412,9 @@ gchar *itdb_get_path (const gchar *dir, const gchar *file)
  *
  * Return value: path to the iTunes directory or NULL if non-existent.
  * Must g_free() after use.
- **/
+ *
+ * Since: 0.4.0
+ */
 gchar *itdb_get_itunes_dir (const gchar *mountpoint)
 {
     g_return_val_if_fail (mountpoint, NULL);
@@ -6440,7 +6448,9 @@ gchar *itdb_get_music_dir (const gchar *mountpoint)
  *
  * Return value: path to the Device directory or NULL if
  * non-existent. Must g_free() after use.
- **/
+ *
+ * Since: 0.4.0
+ */
 gchar *itdb_get_device_dir (const gchar *mountpoint)
 {
     g_return_val_if_fail (mountpoint, NULL);
@@ -6457,7 +6467,9 @@ gchar *itdb_get_device_dir (const gchar *mountpoint)
  *
  * Return value: path to the Artwork directory or NULL if
  * non-existent. Must g_free() after use.
- **/
+ *
+ * Since: 0.4.0
+ */
 gchar *itdb_get_artwork_dir (const gchar *mountpoint)
 {
     g_return_val_if_fail (mountpoint, NULL);
@@ -6473,7 +6485,9 @@ gchar *itdb_get_artwork_dir (const gchar *mountpoint)
  *
  * Return value: path to the iTunesDB or NULL if non-existent. Must g_free()
  * after use.
- **/
+ *
+ * Since: 0.4.0
+ */
 gchar *itdb_get_itunesdb_path (const gchar *mountpoint)
 {
     gchar *itunes_dir, *path=NULL;
@@ -6499,7 +6513,9 @@ gchar *itdb_get_itunesdb_path (const gchar *mountpoint)
  *
  * Return value: path to the iTunesSD or NULL if non-existent. Must g_free()
  * after use.
- **/
+ *
+ * Since: 0.4.0
+ */
 gchar *itdb_get_itunessd_path (const gchar *mountpoint)
 {
     gchar *itunes_dir, *path=NULL;
@@ -6525,7 +6541,9 @@ gchar *itdb_get_itunessd_path (const gchar *mountpoint)
  *
  * Return value: path to the ArtworkDB or NULL if non-existent. Must g_free()
  * after use.
- **/
+ *
+ * Since: 0.4.0
+ */
 gchar *itdb_get_artworkdb_path (const gchar *mountpoint)
 {
     gchar *itunes_dir, *path=NULL;
@@ -6616,8 +6634,9 @@ time_t itdb_time_host_to_mac (time_t time)
  * type of iPod.
  * 
  * Return value: TRUE when successful, FALSE if a failure has occurred.
- * 
- **/
+ *
+ * Since: 0.4.0
+ */
 gboolean itdb_init_ipod (const gchar *mountpoint,
 			 const gchar *model_number,
 			 const gchar *ipod_name,
diff --git a/src/itdb_photoalbum.c b/src/itdb_photoalbum.c
index 730c325..cf6238e 100644
--- a/src/itdb_photoalbum.c
+++ b/src/itdb_photoalbum.c
@@ -123,6 +123,8 @@ static void error_no_photos_dir (const gchar *mp, GError **error)
  *
  * Return value: path to the Artwork directory or NULL if
  * non-existent. Must g_free() after use.
+ *
+ * Since: 0.4.0
  */
 gchar *itdb_get_photos_dir (const gchar *mountpoint)
 {
@@ -151,7 +153,9 @@ gchar *itdb_get_photos_dir (const gchar *mountpoint)
  *
  * Return value: path to the PhotoDB or NULL if non-existent. Must
  * g_free() after use.
- **/
+ *
+ * Since: 0.4.0
+ */
 gchar *itdb_get_photodb_path (const gchar *mountpoint)
 {
     gchar *photo_dir, *path=NULL;
@@ -178,6 +182,8 @@ gchar *itdb_get_photodb_path (const gchar *mountpoint)
  *
  * Return value: path to the Artwork directory or NULL if
  * non-existent. Must g_free() after use.
+ *
+ * Since: 0.4.0
  */
 gchar *itdb_get_photos_thumb_dir (const gchar *mountpoint)
 {
@@ -207,7 +213,9 @@ gchar *itdb_get_photos_thumb_dir (const gchar *mountpoint)
  * Parses the photo database of an iPod mounted at @mp.
  *
  * Return value: the imported PhotoDB or NULL in case of an error.
- **/
+ *
+ * Since: 0.4.0
+ */
 Itdb_PhotoDB *itdb_photodb_parse (const gchar *mp, GError **error)
 {
     gchar *photos_dir;
@@ -282,7 +290,9 @@ static Itdb_PhotoDB *itdb_photodb_new (void)
  * @photodb: an #Itdb_PhotoDB
  *
  * Free the memory taken by @photodb.
- **/
+ *
+ * Since: 0.4.0
+ */
 void itdb_photodb_free (Itdb_PhotoDB *photodb)
 {
 	if (photodb)
@@ -479,7 +489,9 @@ static Itdb_Artwork *itdb_photodb_add_photo_internal (Itdb_PhotoDB *db,
  * ..._CLOCKWISE.
  *
  * Return value: a pointer to the added photo.
- **/
+ *
+ * Since: 0.4.0
+ */
 Itdb_Artwork *itdb_photodb_add_photo (Itdb_PhotoDB *db,
 				      const gchar *filename,
 				      gint position,
@@ -514,7 +526,9 @@ Itdb_Artwork *itdb_photodb_add_photo (Itdb_PhotoDB *db,
  * ..._CLOCKWISE.
  *
  * Return value: a pointer to the added photo.
- **/
+ *
+ * Since: 0.4.0
+ */
 Itdb_Artwork *itdb_photodb_add_photo_from_data (Itdb_PhotoDB *db,
 						const guchar *image_data,
 						gsize image_data_len,
@@ -580,6 +594,8 @@ Itdb_Artwork *itdb_photodb_add_photo_from_pixbuf (Itdb_PhotoDB *db,
  *
  * @photo will be freed and can no longer be used if removed from the
  * first photoalbum.
+ *
+ * Since: 0.4.0
  */
 void itdb_photodb_remove_photo (Itdb_PhotoDB *db,
 				Itdb_PhotoAlbum *album,
@@ -753,7 +769,9 @@ Itdb_PhotoAlbum *itdb_photodb_photoalbum_create (Itdb_PhotoDB *db,
  *
  * Return value: TRUE on success, FALSE on error, in which case @error is
  * set accordingly.
- **/
+ *
+ * Since: 0.4.0
+ */
 gboolean itdb_photodb_write (Itdb_PhotoDB *photodb, GError **error)
 {
     gint result;
diff --git a/src/itdb_track.c b/src/itdb_track.c
index 9b1fefa..5b0341c 100644
--- a/src/itdb_track.c
+++ b/src/itdb_track.c
@@ -464,7 +464,9 @@ gboolean itdb_track_set_thumbnails (Itdb_Track *track,
  * similar function is called.
  *
  * Return value: TRUE if the thumbnail could be added, FALSE otherwise.
- **/
+ *
+ * Since: 0.4.0
+ */
 gboolean itdb_track_set_thumbnails_from_data (Itdb_Track *track,
 					      const guchar *image_data,
 					      gsize image_data_len)