[brasero] API documentation for BraseroTrackDisc

[Philippe Rouquier <philippr src gnome org>]

commit 7ef48a4baa1551bc24f7e67fae3ab6b4cf1822e0
Author: Philippe Rouquier <bonfire-app wanadoo fr>
Date:   Sun Aug 2 17:47:12 2009 +0200

    API documentation for BraseroTrackDisc

 libbrasero-burn/brasero-track-disc.c |   64 ++++++++++++++++++++++++++++++++++
 1 files changed, 64 insertions(+), 0 deletions(-)
---
diff --git a/libbrasero-burn/brasero-track-disc.c b/libbrasero-burn/brasero-track-disc.c
index 108b62c..23ffe9b 100644
--- a/libbrasero-burn/brasero-track-disc.c
+++ b/libbrasero-burn/brasero-track-disc.c
@@ -52,6 +52,18 @@ struct _BraseroTrackDiscPrivate
 
 G_DEFINE_TYPE (BraseroTrackDisc, brasero_track_disc, BRASERO_TYPE_TRACK);
 
+/**
+ * brasero_track_disc_set_track_num:
+ * @track: a #BraseroTrackDisc
+ * @num: a #guint
+ *
+ * Sets a track number which can be used
+ * to copy only one specific session on a multisession disc
+ *
+ * Return value: a #BraseroBurnResult.
+ * BRASERO_BURN_OK if it was successful,
+ * BRASERO_BURN_ERR otherwise.
+ **/
 
 BraseroBurnResult
 brasero_track_disc_set_track_num (BraseroTrackDisc *track,
@@ -67,6 +79,16 @@ brasero_track_disc_set_track_num (BraseroTrackDisc *track,
 	return BRASERO_BURN_OK;
 }
 
+/**
+ * brasero_track_disc_get_track_num:
+ * @track: a #BraseroTrackDisc
+ *
+ * Gets the track number which will be used
+ * to copy only one specific session on a multisession disc
+ *
+ * Return value: a #guint. 0 if none is set, any other number otherwise.
+ **/
+
 guint
 brasero_track_disc_get_track_num (BraseroTrackDisc *track)
 {
@@ -109,6 +131,19 @@ brasero_track_disc_medium_changed (BraseroDrive *drive,
 	brasero_track_changed (track);
 }
 
+/**
+ * brasero_track_disc_set_drive:
+ * @track: a #BraseroTrackDisc
+ * @drive: a #BraseroDrive
+ *
+ * Sets @drive to be the #BraseroDrive that will be used
+ * as the source when copying
+ *
+ * Return value: a #BraseroBurnResult.
+ * BRASERO_BURN_OK if it was successful,
+ * BRASERO_BURN_ERR otherwise.
+ **/
+
 BraseroBurnResult
 brasero_track_disc_set_drive (BraseroTrackDisc *track,
 			      BraseroDrive *drive)
@@ -142,6 +177,16 @@ brasero_track_disc_set_drive (BraseroTrackDisc *track,
 	return BRASERO_BURN_OK;
 }
 
+/**
+ * brasero_track_disc_get_drive:
+ * @track: a #BraseroTrackDisc
+ *
+ * Gets the #BraseroDrive object that will be used as
+ * the source when copying.
+ *
+ * Return value: a #BraseroDrive or NULL
+ **/
+
 BraseroDrive *
 brasero_track_disc_get_drive (BraseroTrackDisc *track)
 {
@@ -153,6 +198,17 @@ brasero_track_disc_get_drive (BraseroTrackDisc *track)
 	return priv->drive;
 }
 
+/**
+ * brasero_track_disc_get_medium_type:
+ * @track: a #BraseroTrackDisc
+ *
+ * Gets the #BraseroMedia for the medium that is
+ * currently inserted into the drive assigned for @track
+ * with brasero_track_disc_set_drive ().
+ *
+ * Return value: a #BraseroMedia.
+ **/
+
 BraseroMedia
 brasero_track_disc_get_medium_type (BraseroTrackDisc *track)
 {
@@ -241,6 +297,14 @@ brasero_track_disc_class_init (BraseroTrackDiscClass *klass)
 	track_class->get_type = brasero_track_disc_get_track_type;
 }
 
+/**
+ * brasero_track_disc_new:
+ *
+ * Creates a new #BraseroTrackDisc object.
+ *
+ * Return value: a #BraseroTrackDisc.
+ **/
+
 BraseroTrackDisc *
 brasero_track_disc_new (void)
 {