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

[philippr svn gnome org]

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

Log:
2009-01-16  Philippe Rouquier  <bonfire-app wanadoo fr>

	Some fixes for API documentation

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

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-medium-monitor.c
   trunk/libbrasero-media/brasero-medium-selection.c
   trunk/libbrasero-media/brasero-medium-selection.h
   trunk/libbrasero-media/brasero-medium.h

Modified: trunk/docs/reference/Makefile.am
==============================================================================
--- trunk/docs/reference/Makefile.am	(original)
+++ trunk/docs/reference/Makefile.am	Fri Jan 16 19:49:42 2009
@@ -81,7 +81,8 @@
 		brasero-media-private.h	\
 		burn-susp.h		\
 		burn-hal-watch.h	\
-		libbrasero-marshal.h
+		libbrasero-marshal.h	\
+		brasero-gio-operation.h
 
 # Images to copy into HTML directory.
 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png

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 19:49:42 2009
@@ -612,11 +612,15 @@
 	combo_class->changed = brasero_drive_selection_changed;
 
 	g_object_class_install_property (object_class, PROP_DRIVE,
-					 g_param_spec_object (_("drive"), NULL, NULL,
+					 g_param_spec_object (_("Drive"),
+							      "Selected drive",
+							      "The currently selected drive",
 							      BRASERO_TYPE_DRIVE, G_PARAM_READWRITE));
 
 	g_object_class_install_property (object_class, PROP_DRIVE_TYPE,
-					 g_param_spec_uint ("drive-type", NULL, NULL,
+					 g_param_spec_uint ("drive-type",
+							    "The type of drives",
+							    "The type of drives displayed",
 							    0, BRASERO_DRIVE_TYPE_ALL,
 							    BRASERO_DRIVE_TYPE_ALL_BUT_FILE,
 							    G_PARAM_READWRITE));

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 19:49:42 2009
@@ -60,14 +60,14 @@
 GtkWidget* brasero_drive_selection_new (void);
 
 BraseroDrive *
-brasero_drive_selection_get_active (BraseroDriveSelection *selection);
+brasero_drive_selection_get_active (BraseroDriveSelection *selector);
 
 gboolean
-brasero_drive_selection_set_active (BraseroDriveSelection *selection,
+brasero_drive_selection_set_active (BraseroDriveSelection *selector,
 				    BraseroDrive *drive);
 
 void
-brasero_drive_selection_show_type (BraseroDriveSelection *selection,
+brasero_drive_selection_show_type (BraseroDriveSelection *selector,
 				   BraseroDriveType type);
 
 G_END_DECLS

Modified: trunk/libbrasero-media/brasero-drive.c
==============================================================================
--- trunk/libbrasero-media/brasero-drive.c	(original)
+++ trunk/libbrasero-media/brasero-drive.c	Fri Jan 16 19:49:42 2009
@@ -724,7 +724,7 @@
 
 /**
  * brasero_drive_reprobe:
- * @monitor: a #BraseroDrive
+ * @drive: a #BraseroDrive
  *
  * Reprobes the drive contents. Useful when an operation has just been performed
  * (blanking, burning, ...) and medium status should be updated.

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 19:49:42 2009
@@ -153,7 +153,7 @@
 /**
  * brasero_medium_monitor_get_drives:
  * @monitor: a #BraseroMediumMonitor
- * @include_fake: a #BraseroDriveType to tell what type of drives to include in the list
+ * @type: a #BraseroDriveType to tell what type of drives to include in the list
  *
  * Obtains the list of available drives.
  *

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 19:49:42 2009
@@ -800,11 +800,15 @@
 	combo_class->changed = brasero_medium_selection_changed;
 
 	g_object_class_install_property (object_class, PROP_MEDIUM,
-					 g_param_spec_object ("medium", NULL, NULL,
+					 g_param_spec_object ("medium",
+							      "Selected medium",
+							      "The currently selected medium",
 							      BRASERO_TYPE_MEDIUM, G_PARAM_READWRITE));
 
 	g_object_class_install_property (object_class, PROP_MEDIA_TYPE,
-					 g_param_spec_uint ("media-type", NULL, NULL,
+					 g_param_spec_uint ("media-type",
+							    "The type of media",
+							    "The type of media displayed",
 							    0, BRASERO_MEDIA_TYPE_ALL,
 							    BRASERO_MEDIA_TYPE_NONE,
 							    G_PARAM_READWRITE));

Modified: trunk/libbrasero-media/brasero-medium-selection.h
==============================================================================
--- trunk/libbrasero-media/brasero-medium-selection.h	(original)
+++ trunk/libbrasero-media/brasero-medium-selection.h	Fri Jan 16 19:49:42 2009
@@ -65,14 +65,14 @@
 GtkWidget* brasero_medium_selection_new (void);
 
 BraseroMedium *
-brasero_medium_selection_get_active (BraseroMediumSelection *selection);
+brasero_medium_selection_get_active (BraseroMediumSelection *selector);
 
 gboolean
-brasero_medium_selection_set_active (BraseroMediumSelection *selection,
+brasero_medium_selection_set_active (BraseroMediumSelection *selector,
 				     BraseroMedium *medium);
 
 void
-brasero_medium_selection_show_media_type (BraseroMediumSelection *selection,
+brasero_medium_selection_show_media_type (BraseroMediumSelection *selector,
 					  BraseroMediaType type);
 
 G_END_DECLS

Modified: trunk/libbrasero-media/brasero-medium.h
==============================================================================
--- trunk/libbrasero-media/brasero-medium.h	(original)
+++ trunk/libbrasero-media/brasero-medium.h	Fri Jan 16 19:49:42 2009
@@ -96,7 +96,7 @@
 brasero_medium_get_tooltip (BraseroMedium *medium);
 
 BraseroDrive *
-brasero_medium_get_drive (BraseroMedium *self);
+brasero_medium_get_drive (BraseroMedium *medium);
 
 guint
 brasero_medium_get_track_num (BraseroMedium *medium);