[brasero] Fix API documentation



commit 2600cf0473f7e62b3d1705c79fc7677b104082b2
Author: Philippe Rouquier <bonfire-app wanadoo fr>
Date:   Tue Aug 18 21:59:10 2009 +0200

    Fix API documentation

 libbrasero-burn/brasero-session.c |   17 +++++++++++++++--
 1 files changed, 15 insertions(+), 2 deletions(-)
---
diff --git a/libbrasero-burn/brasero-session.c b/libbrasero-burn/brasero-session.c
index c72c69a..ff18339 100644
--- a/libbrasero-burn/brasero-session.c
+++ b/libbrasero-burn/brasero-session.c
@@ -58,9 +58,21 @@
 #include "brasero-track.h"
 #include "brasero-track-disc.h"
 
+
 G_DEFINE_TYPE (BraseroBurnSession, brasero_burn_session, G_TYPE_OBJECT);
 #define BRASERO_BURN_SESSION_PRIVATE(o)  (G_TYPE_INSTANCE_GET_PRIVATE ((o), BRASERO_TYPE_BURN_SESSION, BraseroBurnSessionPrivate))
 
+/**
+ * SECTION:BraseroBurnSession
+ * @short_description: #BraseroBurnSession
+ * @see_also: #BraseroBurn #BraseroBurnSessionCfg
+ * @include: brasero-session.h
+ *
+ * This object stores all parameters for all operations performed by #BraseroBurn such as
+ * burning, blanking and checksuming. To have this object configured automatically see
+ * #BraseroBurnSessionCfg.
+ **/
+
 struct _BraseroSessionSetting {
 	BraseroDrive *burner;
 
@@ -2407,10 +2419,11 @@ brasero_burn_session_class_init (BraseroBurnSessionClass *klass)
 			  0);
 
 	/**
- 	* BraseroBurnSession::flags-changed:
+ 	* BraseroBurnSession::tag-changed:
  	* @session: the object which received the signal
 	*
- 	* This signal gets emitted when the flags changed for @session.
+ 	* This signal gets emitted when a tag changed for @session (whether it
+	* was removed, added, or it changed).
  	*
  	*/
 	brasero_burn_session_signals [TAG_CHANGED_SIGNAL] =



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]