[brasero] Start to document libbrasero-burn API

[Philippe Rouquier <philippr src gnome org>]

commit 45edc9f9f927c971545d200cea140d515236a92e
Author: Philippe Rouquier <bonfire-app wanadoo fr>
Date:   Wed Jul 22 16:56:54 2009 +0200

    Start to document libbrasero-burn API

 libbrasero-burn/brasero-blank-dialog.c      |    7 +++++++
 libbrasero-burn/brasero-burn-dialog.c       |   26 ++++++++++++++++++++++++++
 libbrasero-burn/brasero-sum-dialog.c        |    7 +++++++
 libbrasero-media/brasero-drive-selection.c  |   10 +++++++++-
 libbrasero-media/brasero-medium-selection.c |    7 +++++++
 5 files changed, 56 insertions(+), 1 deletions(-)
---
diff --git a/libbrasero-burn/brasero-blank-dialog.c b/libbrasero-burn/brasero-blank-dialog.c
index d37e8d3..5a64395 100644
--- a/libbrasero-burn/brasero-blank-dialog.c
+++ b/libbrasero-burn/brasero-blank-dialog.c
@@ -404,6 +404,13 @@ brasero_blank_dialog_init (BraseroBlankDialog *obj)
 		gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->fast), TRUE);
 }
 
+/**
+ * brasero_blank_dialog_new:
+ *
+ * Creates a new #BraseroBlankDialog object
+ *
+ * Return value: a #BraseroBlankDialog. Unref when it is not needed anymore.
+ **/
 BraseroBlankDialog *
 brasero_blank_dialog_new ()
 {
diff --git a/libbrasero-burn/brasero-burn-dialog.c b/libbrasero-burn/brasero-burn-dialog.c
index 9dcd232..435a40f 100644
--- a/libbrasero-burn/brasero-burn-dialog.c
+++ b/libbrasero-burn/brasero-burn-dialog.c
@@ -1379,6 +1379,13 @@ brasero_burn_dialog_finalize (GObject * object)
 	G_OBJECT_CLASS (parent_class)->finalize (object);
 }
 
+/**
+ * brasero_burn_dialog_new:
+ *
+ * Creates a new #BraseroBurnDialog object
+ *
+ * Return value: a #GtkWidget. Unref when it is not needed anymore.
+ **/
 GtkWidget *
 brasero_burn_dialog_new (void)
 {
@@ -2224,6 +2231,15 @@ brasero_burn_dialog_wait_for_ready_state (BraseroBurnDialog *dialog)
 	return (result == BRASERO_BURN_OK);
 }
 
+/**
+ * brasero_burn_dialog_run:
+ * @dialog: a #BraseroBurnDialog
+ * @session: a #BraseroBurnSession
+ *
+ * Start burning the contents of @session.
+ *
+ * Return value: a #gboolean. TRUE if the operation was successfully carried out, FALSE otherwise.
+ **/
 gboolean
 brasero_burn_dialog_run (BraseroBurnDialog *dialog,
 			 BraseroBurnSession *session)
@@ -2306,6 +2322,16 @@ brasero_burn_dialog_cancel_dialog (GtkWidget *toplevel)
 	return (result != GTK_RESPONSE_OK);
 }
 
+/**
+ * brasero_burn_dialog_cancel:
+ * @dialog: a #BraseroBurnDialog
+ * @force_cancellation: a #gboolean
+ *
+ * Cancel the ongoing operation run by @dialog; if @force_cancellation is FALSE then it can
+ * happen that the operation won't be cancelled if there is a risk to make a disc unusable.
+ *
+ * Return value: a #gboolean. TRUE if it was sucessfully cancelled, FALSE otherwise.
+ **/
 gboolean
 brasero_burn_dialog_cancel (BraseroBurnDialog *dialog,
 			    gboolean force_cancellation)
diff --git a/libbrasero-burn/brasero-sum-dialog.c b/libbrasero-burn/brasero-sum-dialog.c
index e9bdf6b..8569143 100644
--- a/libbrasero-burn/brasero-sum-dialog.c
+++ b/libbrasero-burn/brasero-sum-dialog.c
@@ -727,6 +727,13 @@ brasero_sum_dialog_init (BraseroSumDialog *obj)
 		brasero_tool_dialog_set_valid (BRASERO_TOOL_DIALOG (obj), FALSE);
 }
 
+/**
+ * brasero_sum_dialog_new:
+ *
+ * Creates a new #BraseroSumDialog object
+ *
+ * Return value: a #BraseroSumDialog. Unref when it is not needed anymore.
+ **/
 BraseroSumDialog *
 brasero_sum_dialog_new ()
 {
diff --git a/libbrasero-media/brasero-drive-selection.c b/libbrasero-media/brasero-drive-selection.c
index 1d7b286..5758c18 100644
--- a/libbrasero-media/brasero-drive-selection.c
+++ b/libbrasero-media/brasero-drive-selection.c
@@ -664,7 +664,15 @@ brasero_drive_selection_class_init (BraseroDriveSelectionClass *klass)
 			  1,
 			  BRASERO_TYPE_DRIVE);
 }
-  
+
+/**
+ * brasero_drive_selection_new:
+ *
+ * Creates a new #BraseroDriveSelection object
+ *
+ * Return value: a #GtkWidget. Unref when it is not needed anymore.
+ **/
+
 GtkWidget *
 brasero_drive_selection_new (void)
 {
diff --git a/libbrasero-media/brasero-medium-selection.c b/libbrasero-media/brasero-medium-selection.c
index 1b32d45..26acd27 100644
--- a/libbrasero-media/brasero-medium-selection.c
+++ b/libbrasero-media/brasero-medium-selection.c
@@ -917,6 +917,13 @@ brasero_medium_selection_class_init (BraseroMediumSelectionClass *klass)
 			  BRASERO_TYPE_MEDIUM);
 }
 
+/**
+ * brasero_medium_selection_new:
+ *
+ * Creates a new #BraseroMediumSelection object
+ *
+ * Return value: a #GtkWidget. Unref when it is not needed anymore.
+ **/
 GtkWidget *
 brasero_medium_selection_new (void)
 {