brasero r1759 - in trunk: . docs/reference libbrasero-media

[philippr svn gnome org]

Author: philippr
Date: Fri Jan 16 21:03:19 2009
New Revision: 1759
URL: http://svn.gnome.org/viewvc/brasero?rev=1759&view=rev

Log:
2009-01-16  Philippe Rouquier  <ykw localhost localdomain>

	Some fixes for API documentation

	* docs/reference/Makefile.am:
	* libbrasero-media/brasero-drive-selection.c
	(brasero_drive_selection_class_init):
	* libbrasero-media/brasero-drive-selection.h:
	* libbrasero-media/brasero-drive.c (brasero_drive_class_init):
	* libbrasero-media/brasero-drive.h:
	* libbrasero-media/brasero-medium-monitor.c
	(brasero_medium_monitor_class_init):
	* libbrasero-media/brasero-medium-monitor.h:
	* libbrasero-media/brasero-medium-selection.c
	(brasero_medium_selection_class_init):
	* libbrasero-media/brasero-medium.c:

Modified:
   trunk/ChangeLog
   trunk/docs/reference/Makefile.am
   trunk/libbrasero-media/brasero-drive-selection.c
   trunk/libbrasero-media/brasero-drive-selection.h
   trunk/libbrasero-media/brasero-drive.c
   trunk/libbrasero-media/brasero-drive.h
   trunk/libbrasero-media/brasero-medium-monitor.c
   trunk/libbrasero-media/brasero-medium-monitor.h
   trunk/libbrasero-media/brasero-medium-selection.c
   trunk/libbrasero-media/brasero-medium.c

Modified: trunk/docs/reference/Makefile.am
==============================================================================
--- trunk/docs/reference/Makefile.am	(original)
+++ trunk/docs/reference/Makefile.am	Fri Jan 16 21:03:19 2009
@@ -79,6 +79,7 @@
 		burn-volume.h		\
 		burn-volume-source.h	\
 		brasero-media-private.h	\
+		brasero-medium-selection-priv.h	\
 		burn-susp.h		\
 		burn-hal-watch.h	\
 		libbrasero-marshal.h	\

Modified: trunk/libbrasero-media/brasero-drive-selection.c
==============================================================================
--- trunk/libbrasero-media/brasero-drive-selection.c	(original)
+++ trunk/libbrasero-media/brasero-drive-selection.c	Fri Jan 16 21:03:19 2009
@@ -625,9 +625,9 @@
 							    BRASERO_DRIVE_TYPE_ALL_BUT_FILE,
 							    G_PARAM_READWRITE));
 	/**
- 	* BraseroDriveSelection::drive_changed:
- 	* @selection: the object which received the signal
-  	* @medium: the medium which is now selected
+ 	* BraseroDriveSelection::drive-changed:
+ 	* @selector: the object which received the signal
+  	* @drive: the drive which is now selected
 	*
  	* This signal gets emitted when the selected medium has changed
  	*

Modified: trunk/libbrasero-media/brasero-drive-selection.h
==============================================================================
--- trunk/libbrasero-media/brasero-drive-selection.h	(original)
+++ trunk/libbrasero-media/brasero-drive-selection.h	Fri Jan 16 21:03:19 2009
@@ -47,7 +47,7 @@
 	GtkComboBoxClass parent_class;
 
 	/* Signals */
-	void		(* drive_changed)		(BraseroDriveSelection *selection,
+	void		(* drive_changed)		(BraseroDriveSelection *selector,
 							 BraseroDrive *drive);
 };
 

Modified: trunk/libbrasero-media/brasero-drive.c
==============================================================================
--- trunk/libbrasero-media/brasero-drive.c	(original)
+++ trunk/libbrasero-media/brasero-drive.c	Fri Jan 16 21:03:19 2009
@@ -568,7 +568,7 @@
  * Gets the medium currently inserted in the drive. If there is no medium or if
  * the medium is not probed yet then it returns NULL.
  *
- * Return value: a #BraseroMedium object or NULL
+ * Return value: a #BraseroMedium object or NULL. No need to unref after use.
  **/
 BraseroMedium *
 brasero_drive_get_medium (BraseroDrive *drive)
@@ -1031,7 +1031,7 @@
 	object_class->get_property = brasero_drive_get_property;
 
 	/**
- 	* BraseroVolumeMonitor::medium-added:
+ 	* BraseroDrive::medium-added:
  	* @drive: the object which received the signal
   	* @medium: the new medium which was added
 	*
@@ -1049,7 +1049,7 @@
 		              BRASERO_TYPE_MEDIUM);
 
 	/**
- 	* BraseroVolumeMonitor::medium-removed:
+ 	* BraseroDrive::medium-removed:
  	* @drive: the object which received the signal
   	* @medium: the medium which was removed
 	*

Modified: trunk/libbrasero-media/brasero-drive.h
==============================================================================
--- trunk/libbrasero-media/brasero-drive.h	(original)
+++ trunk/libbrasero-media/brasero-drive.h	Fri Jan 16 21:03:19 2009
@@ -59,10 +59,10 @@
 	GObjectClass parent_class;
 
 	/* Signals */
-	void		(*medium_added)		(BraseroDrive *drive,
+	void		(* medium_added)	(BraseroDrive *drive,
 						 BraseroMedium *medium);
 
-	void		(*medium_removed)	(BraseroDrive *drive,
+	void		(* medium_removed)	(BraseroDrive *drive,
 						 BraseroMedium *medium);
 };
 

Modified: trunk/libbrasero-media/brasero-medium-monitor.c
==============================================================================
--- trunk/libbrasero-media/brasero-medium-monitor.c	(original)
+++ trunk/libbrasero-media/brasero-medium-monitor.c	Fri Jan 16 21:03:19 2009
@@ -155,7 +155,7 @@
  * @monitor: a #BraseroMediumMonitor
  * @type: a #BraseroDriveType to tell what type of drives to include in the list
  *
- * Obtains the list of available drives.
+ * Gets the list of available drives that are of the given type.
  *
  * Return value: a #GSList or NULL
  **/
@@ -483,13 +483,12 @@
 	object_class->finalize = brasero_medium_monitor_finalize;
 
 	/**
- 	* BraseroVolumeMonitor::medium-added:
+ 	* BraseroMediumMonitor::medium-added:
  	* @monitor: the object which received the signal
   	* @medium: the new medium which was added
 	*
  	* This signal gets emitted when a new medium was detected
- 	*
- 	*/
+ 	**/
 	medium_monitor_signals[MEDIUM_INSERTED] =
 		g_signal_new ("medium_added",
 		              G_OBJECT_CLASS_TYPE (klass),
@@ -501,13 +500,12 @@
 		              BRASERO_TYPE_MEDIUM);
 
 	/**
- 	* BraseroVolumeMonitor::medium-removed:
+ 	* BraseroMediumMonitor::medium-removed:
  	* @monitor: the object which received the signal
   	* @medium: the medium which was removed
 	*
  	* This signal gets emitted when a medium is not longer available
- 	*
- 	*/
+ 	**/
 	medium_monitor_signals[MEDIUM_REMOVED] =
 		g_signal_new ("medium_removed",
 		              G_OBJECT_CLASS_TYPE (klass),
@@ -519,13 +517,12 @@
 		              BRASERO_TYPE_MEDIUM);
 
 	/**
- 	* BraseroVolumeMonitor::drive-added:
+ 	* BraseroMediumMonitor::drive-added:
  	* @monitor: the object which received the signal
   	* @medium: the new medium which was added
 	*
  	* This signal gets emitted when a new drive was detected
- 	*
- 	*/
+ 	**/
 	medium_monitor_signals[DRIVE_ADDED] =
 		g_signal_new ("drive_added",
 		              G_OBJECT_CLASS_TYPE (klass),
@@ -537,13 +534,12 @@
 		              BRASERO_TYPE_DRIVE);
 
 	/**
- 	* BraseroVolumeMonitor::drive-removed:
+ 	* BraseroMediumMonitor::drive-removed:
  	* @monitor: the object which received the signal
   	* @medium: the medium which was removed
 	*
  	* This signal gets emitted when a drive is not longer available
- 	*
- 	*/
+ 	**/
 	medium_monitor_signals[DRIVE_REMOVED] =
 		g_signal_new ("drive_removed",
 		              G_OBJECT_CLASS_TYPE (klass),

Modified: trunk/libbrasero-media/brasero-medium-monitor.h
==============================================================================
--- trunk/libbrasero-media/brasero-medium-monitor.h	(original)
+++ trunk/libbrasero-media/brasero-medium-monitor.h	Fri Jan 16 21:03:19 2009
@@ -46,16 +46,16 @@
 	GObjectClass parent_class;
 
 	/* Signals */
-	void		(*drive_added)		(BraseroMediumMonitor *monitor,
+	void		(* drive_added)		(BraseroMediumMonitor *monitor,
 						 BraseroDrive *drive);
 
-	void		(*drive_removed)	(BraseroMediumMonitor *monitor,
+	void		(* drive_removed)	(BraseroMediumMonitor *monitor,
 						 BraseroDrive *drive);
 
-	void		(*medium_added)		(BraseroMediumMonitor *monitor,
+	void		(* medium_added)	(BraseroMediumMonitor *monitor,
 						 BraseroMedium *medium);
 
-	void		(*medium_removed)	(BraseroMediumMonitor *monitor,
+	void		(* medium_removed)	(BraseroMediumMonitor *monitor,
 						 BraseroMedium *medium);
 };
 

Modified: trunk/libbrasero-media/brasero-medium-selection.c
==============================================================================
--- trunk/libbrasero-media/brasero-medium-selection.c	(original)
+++ trunk/libbrasero-media/brasero-medium-selection.c	Fri Jan 16 21:03:19 2009
@@ -812,6 +812,13 @@
 							    0, BRASERO_MEDIA_TYPE_ALL,
 							    BRASERO_MEDIA_TYPE_NONE,
 							    G_PARAM_READWRITE));
+	/**
+ 	* BraseroMediumSelection::medium-changed:
+ 	* @monitor: the object which received the signal
+  	* @medium: the new selected medium
+	*
+ 	* This signal gets emitted when the selected medium has changed.
+ 	**/
 	brasero_medium_selection_signals [CHANGED_SIGNAL] =
 	    g_signal_new ("medium_changed",
 			  BRASERO_TYPE_MEDIUM_SELECTION,

Modified: trunk/libbrasero-media/brasero-medium.c
==============================================================================
--- trunk/libbrasero-media/brasero-medium.c	(original)
+++ trunk/libbrasero-media/brasero-medium.c	Fri Jan 16 21:03:19 2009
@@ -233,6 +233,16 @@
 	return TRUE;
 }
 
+/**
+ * brasero_medium_get_tooltip:
+ * @medium: #BraseroMedium
+ *
+ * Returns a tooltip to be displayed in the UI.
+ * It is of the form {content type} {disc type} in {drive name}.
+ *
+ * Return value: a #gchar *.
+ *
+ **/
 gchar *
 brasero_medium_get_tooltip (BraseroMedium *self)
 {
@@ -3604,7 +3614,7 @@
  *
  * Gets the #BraseroDrive in which the medium is inserted.
  *
- * Return value: a #BraseroDrive.
+ * Return value: a #BraseroDrive. No need to unref after use.
  *
  **/
 BraseroDrive *