[brasero] API documentation



commit cb668290bb95ddb00bd18a09bbe1e34ff67714b3
Author: Philippe Rouquier <bonfire-app wanadoo fr>
Date:   Wed Aug 19 15:31:37 2009 +0200

    API documentation

 libbrasero-burn/brasero-session-cfg.c |   10 ++++++++++
 libbrasero-burn/brasero-session.c     |    8 ++++----
 2 files changed, 14 insertions(+), 4 deletions(-)
---
diff --git a/libbrasero-burn/brasero-session-cfg.c b/libbrasero-burn/brasero-session-cfg.c
index 2708a60..96c9142 100644
--- a/libbrasero-burn/brasero-session-cfg.c
+++ b/libbrasero-burn/brasero-session-cfg.c
@@ -55,6 +55,16 @@
 #include "brasero-burn-lib.h"
 #include "brasero-session-helper.h"
 
+/**
+ * SECTION:brasero-session-cfg
+ * @short_description: Configure automatically a #BraseroBurnSession object
+ * @see_also: #BraseroBurn, #BraseroBurnSession
+ * @include: brasero-session-cfg.h
+ *
+ * This object configures automatically a session reacting to any change
+ * made to the various parameters.
+ **/
+
 typedef struct _BraseroSessionCfgPrivate BraseroSessionCfgPrivate;
 struct _BraseroSessionCfgPrivate
 {
diff --git a/libbrasero-burn/brasero-session.c b/libbrasero-burn/brasero-session.c
index c5ad95f..c0f9dd9 100644
--- a/libbrasero-burn/brasero-session.c
+++ b/libbrasero-burn/brasero-session.c
@@ -63,14 +63,14 @@ 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
+ * SECTION:brasero-session
+ * @short_description: Store parameters when burning and blanking
+ * @see_also: #BraseroBurn, #BraseroSessionCfg
  * @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.
+ * #BraseroSessionCfg.
  **/
 
 struct _BraseroSessionSetting {



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