GNOME.org
 

[brasero] Some more API documentation

commit a2b5cfe0cda3c0c927ab61302dd32572ee3a44e8
Author: Philippe Rouquier <bonfire-app wanadoo fr>
Date:   Sun Aug 9 14:51:37 2009 +0200

    Some more API documentation

 .../libbrasero-burn/libbrasero-burn-sections.txt   |    1 -
 libbrasero-burn/brasero-burn-options.c             |   17 ++++
 libbrasero-burn/brasero-session-cfg.c              |   95 +++++++++++++++++-
 libbrasero-burn/brasero-session-cfg.h              |    8 +-
 libbrasero-burn/brasero-tool-dialog.c              |   29 +++++-
 libbrasero-burn/brasero-tool-dialog.h              |    2 +-
 libbrasero-burn/brasero-track-image-cfg.c          |   41 ++++++++
 libbrasero-burn/brasero-track-image.c              |   63 ++++++++++++
 libbrasero-burn/brasero-track-stream-cfg.c         |    8 ++
 libbrasero-burn/brasero-track-stream.c             |  100 ++++++++++++++++++++
 10 files changed, 349 insertions(+), 15 deletions(-)
---
diff --git a/docs/reference/libbrasero-burn/libbrasero-burn-sections.txt b/docs/reference/libbrasero-burn/libbrasero-burn-sections.txt
index 6833c7e..08a887d 100644
--- a/docs/reference/libbrasero-burn/libbrasero-burn-sections.txt
+++ b/docs/reference/libbrasero-burn/libbrasero-burn-sections.txt
@@ -335,7 +335,6 @@ BRASERO_TRACK_DISC_GET_CLASS
 <TITLE>BraseroBurnOptions</TITLE>
 BraseroBurnOptions
 brasero_burn_options_new
-brasero_burn_options_get_session
 brasero_burn_options_add_options
 <SUBSECTION Standard>
 BRASERO_BURN_OPTIONS
diff --git a/libbrasero-burn/brasero-burn-options.c b/libbrasero-burn/brasero-burn-options.c
index 621c2e0..c200f2c 100644
--- a/libbrasero-burn/brasero-burn-options.c
+++ b/libbrasero-burn/brasero-burn-options.c
@@ -141,6 +141,14 @@ brasero_burn_options_add_source (BraseroBurnOptions *self,
 	gtk_widget_show (priv->source_placeholder);
 }
 
+/**
+ * brasero_burn_options_add_options:
+ * @dialog: a #BraseroBurnOptions
+ * @options: a #GtkWidget
+ *
+ * Adds some new options to be displayed in the dialog.
+ **/
+
 void
 brasero_burn_options_add_options (BraseroBurnOptions *self,
 				  GtkWidget *options)
@@ -1021,6 +1029,15 @@ brasero_burn_options_class_init (BraseroBurnOptionsClass *klass)
 							      G_PARAM_READWRITE|G_PARAM_CONSTRUCT_ONLY));
 }
 
+/**
+ * brasero_burn_options_new:
+ * @session: a #BraseroSessionCfg object
+ *
+ *  Creates a new #BraseroBurnOptions object.
+ *
+ * Return value: a #GtkWidget object.
+ **/
+
 GtkWidget *
 brasero_burn_options_new (BraseroSessionCfg *session)
 {
diff --git a/libbrasero-burn/brasero-session-cfg.c b/libbrasero-burn/brasero-session-cfg.c
index cf2d1fd..1373eaa 100644
--- a/libbrasero-burn/brasero-session-cfg.c
+++ b/libbrasero-burn/brasero-session-cfg.c
@@ -89,8 +89,17 @@ G_DEFINE_TYPE (BraseroSessionCfg, brasero_session_cfg, BRASERO_TYPE_SESSION_SPAN
 #define BRASERO_DRIVE_PROPERTIES_KEY		"/apps/brasero/drives"
 
 /**
- * Manages the output path
- */
+ * brasero_session_cfg_has_default_output_path:
+ * @cfg: a #BraseroSessionCfg
+ *
+ * This function returns whether the path returned
+ * by brasero_burn_session_get_output () is an 
+ * automatically created one.
+ *
+ * Return value: a #gboolean. TRUE if the path(s)
+ * creation is handled by @session, FALSE if it was
+ * set.
+ **/
 
 gboolean
 brasero_session_cfg_has_default_output_path (BraseroSessionCfg *session)
@@ -338,6 +347,16 @@ brasero_session_cfg_get_gconf_key (BraseroSessionCfg *self,
 	return key;
 }
 
+/**
+ * brasero_session_cfg_get_error:
+ * @cfg: a #BraseroSessionCfg
+ *
+ * This function returns the current status and if
+ * autoconfiguration is/was successful.
+ *
+ * Return value: a #BraseroSessionError.
+ **/
+
 BraseroSessionError
 brasero_session_cfg_get_error (BraseroSessionCfg *self)
 {
@@ -352,6 +371,14 @@ brasero_session_cfg_get_error (BraseroSessionCfg *self)
 	return priv->is_valid;
 }
 
+/**
+ * brasero_session_cfg_disable:
+ * @cfg: a #BraseroSessionCfg
+ *
+ * This function disables autoconfiguration
+ *
+ **/
+
 void
 brasero_session_cfg_disable (BraseroSessionCfg *self)
 {
@@ -361,6 +388,14 @@ brasero_session_cfg_disable (BraseroSessionCfg *self)
 	priv->disabled = TRUE;
 }
 
+/**
+ * brasero_session_cfg_enable:
+ * @cfg: a #BraseroSessionCfg
+ *
+ * This function (re)-enables autoconfiguration
+ *
+ **/
+
 void
 brasero_session_cfg_enable (BraseroSessionCfg *self)
 {
@@ -1218,6 +1253,15 @@ brasero_session_cfg_flags_changed (BraseroBurnSession *session)
 		g_signal_stop_emission_by_name (session, "flags-changed");
 }
 
+/**
+ * brasero_session_cfg_add_flags:
+ * @cfg: a #BraseroSessionCfg
+ * @flags: a #BraseroBurnFlag
+ *
+ * Adds all flags from @flags that are not supported.
+ *
+ **/
+
 void
 brasero_session_cfg_add_flags (BraseroSessionCfg *self,
 			       BraseroBurnFlag flags)
@@ -1250,6 +1294,15 @@ brasero_session_cfg_add_flags (BraseroSessionCfg *self,
 				    FALSE);
 }
 
+/**
+ * brasero_session_cfg_remove_flags:
+ * @cfg: a #BraseroSessionCfg
+ * @flags: a #BraseroBurnFlag
+ *
+ * Removes all flags that are not compulsory.
+ *
+ **/
+
 void
 brasero_session_cfg_remove_flags (BraseroSessionCfg *self,
 				  BraseroBurnFlag flags)
@@ -1276,24 +1329,46 @@ brasero_session_cfg_remove_flags (BraseroSessionCfg *self,
 				    FALSE);
 }
 
+/**
+ * brasero_session_cfg_is_supported:
+ * @cfg: a #BraseroSessionCfg
+ * @flag: a #BraseroBurnFlag
+ *
+ * Checks whether a particular flag is supported.
+ *
+ * Return value: a #gboolean. TRUE if it is supported;
+ * FALSE otherwise.
+ **/
+
 gboolean
 brasero_session_cfg_is_supported (BraseroSessionCfg *self,
-				  BraseroBurnFlag flags)
+				  BraseroBurnFlag flag)
 {
 	BraseroSessionCfgPrivate *priv;
 
 	priv = BRASERO_SESSION_CFG_PRIVATE (self);
-	return (priv->supported & flags) == flags;
+	return (priv->supported & flag) == flag;
 }
 
+/**
+ * brasero_session_cfg_is_compulsory:
+ * @cfg: a #BraseroSessionCfg
+ * @flag: a #BraseroBurnFlag
+ *
+ * Checks whether a particular flag is compulsory.
+ *
+ * Return value: a #gboolean. TRUE if it is compulsory;
+ * FALSE otherwise.
+ **/
+
 gboolean
 brasero_session_cfg_is_compulsory (BraseroSessionCfg *self,
-				   BraseroBurnFlag flags)
+				   BraseroBurnFlag flag)
 {
 	BraseroSessionCfgPrivate *priv;
 
 	priv = BRASERO_SESSION_CFG_PRIVATE (self);
-	return (priv->compulsory & flags) == flags;
+	return (priv->compulsory & flag) == flag;
 }
 
 static void
@@ -1386,6 +1461,14 @@ brasero_session_cfg_class_init (BraseroSessionCfgClass *klass)
 		              G_TYPE_NONE);
 }
 
+/**
+ * brasero_session_cfg_new:
+ *
+ *  Creates a new #BraseroSessionCfg object.
+ *
+ * Return value: a #BraseroSessionCfg object.
+ **/
+
 BraseroSessionCfg *
 brasero_session_cfg_new (void)
 {
diff --git a/libbrasero-burn/brasero-session-cfg.h b/libbrasero-burn/brasero-session-cfg.h
index 72a3c0c..42ef92b 100644
--- a/libbrasero-burn/brasero-session-cfg.h
+++ b/libbrasero-burn/brasero-session-cfg.h
@@ -103,19 +103,19 @@ brasero_session_cfg_remove_flags (BraseroSessionCfg *cfg,
 				  BraseroBurnFlag flags);
 gboolean
 brasero_session_cfg_is_supported (BraseroSessionCfg *cfg,
-				  BraseroBurnFlag flags);
+				  BraseroBurnFlag flag);
 gboolean
 brasero_session_cfg_is_compulsory (BraseroSessionCfg *cfg,
-				   BraseroBurnFlag flags);
+				   BraseroBurnFlag flag);
 
 gboolean
 brasero_session_cfg_has_default_output_path (BraseroSessionCfg *cfg);
 
 void
-brasero_session_cfg_enable (BraseroSessionCfg *self);
+brasero_session_cfg_enable (BraseroSessionCfg *cfg);
 
 void
-brasero_session_cfg_disable (BraseroSessionCfg *self);
+brasero_session_cfg_disable (BraseroSessionCfg *cfg);
 
 G_END_DECLS
 
diff --git a/libbrasero-burn/brasero-tool-dialog.c b/libbrasero-burn/brasero-tool-dialog.c
index afed31c..a89cbc1 100644
--- a/libbrasero-burn/brasero-tool-dialog.c
+++ b/libbrasero-burn/brasero-tool-dialog.c
@@ -339,6 +339,15 @@ brasero_tool_dialog_set_medium_type_shown (BraseroToolDialog *self,
 						  media_type);
 }
 
+/**
+ * brasero_tool_dialog_get_medium:
+ * @dialog: a #BraseroToolDialog
+ *
+ * This function returns the currently selected medium.
+ *
+ * Return value: a #BraseroMedium or NULL if none is set.
+ **/
+
 BraseroMedium *
 brasero_tool_dialog_get_medium (BraseroToolDialog *self)
 {
@@ -348,6 +357,16 @@ brasero_tool_dialog_get_medium (BraseroToolDialog *self)
 	return brasero_medium_selection_get_active (BRASERO_MEDIUM_SELECTION (priv->selector));
 }
 
+/**
+ * brasero_tool_dialog_set_medium:
+ * @dialog: a #BraseroToolDialog
+ * @medium: a #BraseroMedium
+ *
+ * Selects the medium that should be currently selected.
+ *
+ * Return value: a #gboolean. TRUE if it was successful.
+ **/
+
 gboolean
 brasero_tool_dialog_set_medium (BraseroToolDialog *self,
 				BraseroMedium *medium)
@@ -412,9 +431,13 @@ brasero_tool_dialog_cancel_dialog (GtkWidget *toplevel)
 }
 
 /**
- * returns TRUE when cancellation went well
- * returns FALSE when it couldn't be done
- */
+ * brasero_tool_dialog_cancel:
+ * @dialog: a #BraseroToolDialog
+ *
+ * Cancels any ongoing operation.
+ *
+ * Return value: a #gboolean. TRUE when cancellation was successful. FALSE otherwise.
+ **/
 
 gboolean
 brasero_tool_dialog_cancel (BraseroToolDialog *self)
diff --git a/libbrasero-burn/brasero-tool-dialog.h b/libbrasero-burn/brasero-tool-dialog.h
index 4b11676..7efc694 100644
--- a/libbrasero-burn/brasero-tool-dialog.h
+++ b/libbrasero-burn/brasero-tool-dialog.h
@@ -73,7 +73,7 @@ struct _BraseroToolDialogClass {
 GType brasero_tool_dialog_get_type ();
 
 gboolean
-brasero_tool_dialog_cancel (BraseroToolDialog *self);
+brasero_tool_dialog_cancel (BraseroToolDialog *dialog);
 
 gboolean
 brasero_tool_dialog_set_medium (BraseroToolDialog *dialog,
diff --git a/libbrasero-burn/brasero-track-image-cfg.c b/libbrasero-burn/brasero-track-image-cfg.c
index ef58364..9104d33 100644
--- a/libbrasero-burn/brasero-track-image-cfg.c
+++ b/libbrasero-burn/brasero-track-image-cfg.c
@@ -272,6 +272,16 @@ brasero_track_image_cfg_get_info (BraseroTrackImageCfg *track,
 	g_object_unref (res);
 }
 
+/**
+ * brasero_track_image_cfg_set_source:
+ * @track: a #BraseroTrackImageCfg
+ * @uri: a #gchar
+ *
+ * Sets the image uri. @track will then identify its format and retrieve its size.
+ *
+ * Return value: a #BraseroBurnResult. BRASERO_BURN_OK if it is successful.
+ **/
+
 BraseroBurnResult
 brasero_track_image_cfg_set_source (BraseroTrackImageCfg *track,
 				    const gchar *uri)
@@ -304,6 +314,16 @@ brasero_track_image_cfg_set_source (BraseroTrackImageCfg *track,
 	return BRASERO_BURN_OK;
 }
 
+/**
+ * brasero_track_image_cfg_get_forced_format:
+ * @track: a #BraseroTrackImageCfg
+ *
+ * This function returns the #BraseroImageFormat that was set for the image.
+ * See brasero_track_image_cfg_force_format ().
+ *
+ * Return value: a #BraseroBurnResult. BRASERO_BURN_OK if it is successful.
+ **/
+
 BraseroImageFormat
 brasero_track_image_cfg_get_forced_format (BraseroTrackImageCfg *track)
 {
@@ -315,6 +335,19 @@ brasero_track_image_cfg_get_forced_format (BraseroTrackImageCfg *track)
 	return priv->format;
 }
 
+/**
+ * brasero_track_image_cfg_force_format:
+ * @track: a #BraseroTrackImageCfg
+ * @format: a #BraseroImageFormat
+ *
+ * This function allows to prevents the identification of the format of the image.
+ * It does not cancel size retrieval.
+ * If @format is BRASERO_IMAGE_FORMAT_NONE then the format of the image
+ * will be retrieved.
+ *
+ * Return value: a #BraseroBurnResult. BRASERO_BURN_OK if it is successful.
+ **/
+
 BraseroBurnResult
 brasero_track_image_cfg_force_format (BraseroTrackImageCfg *track,
 				      BraseroImageFormat format)
@@ -445,6 +478,14 @@ brasero_track_image_cfg_class_init (BraseroTrackImageCfgClass *klass)
 	track_class->get_status = brasero_track_image_cfg_get_status;
 }
 
+/**
+ * brasero_track_image_cfg_new:
+ *
+ *  Creates a new #BraseroTrackImageCfg object.
+ *
+ * Return value: a #BraseroTrackImageCfg object.
+ **/
+
 BraseroTrackImageCfg *
 brasero_track_image_cfg_new (void)
 {
diff --git a/libbrasero-burn/brasero-track-image.c b/libbrasero-burn/brasero-track-image.c
index 0d2182d..9be677d 100644
--- a/libbrasero-burn/brasero-track-image.c
+++ b/libbrasero-burn/brasero-track-image.c
@@ -81,6 +81,19 @@ brasero_track_image_set_source_real (BraseroTrackImage *track,
 	return BRASERO_BURN_OK;
 }
 
+/**
+ * brasero_track_image_set_source:
+ * @track: a #BraseroTrackImage
+ * @image: a #gchar or NULL
+ * @toc: a #gchar or NULL
+ * @format: a #BraseroImageFormat
+ *
+ * Sets the image source path (and its toc if need be)
+ * as well as its format.
+ *
+ * Return value: a #BraseroBurnResult. BRASERO_BURN_OK if it is successful.
+ **/
+
 BraseroBurnResult
 brasero_track_image_set_source (BraseroTrackImage *track,
 				const gchar *image,
@@ -119,6 +132,16 @@ brasero_track_image_set_block_num_real (BraseroTrackImage *track,
 	return BRASERO_BURN_OK;
 }
 
+/**
+ * brasero_track_image_set_block_num:
+ * @track: a #BraseroTrackImage
+ * @blocks: a #goffset
+ *
+ * Sets the image size (in sectors).
+ *
+ * Return value: a #BraseroBurnResult. BRASERO_BURN_OK if it is successful.
+ **/
+
 BraseroBurnResult
 brasero_track_image_set_block_num (BraseroTrackImage *track,
 				   goffset blocks)
@@ -145,6 +168,17 @@ brasero_track_image_set_block_num (BraseroTrackImage *track,
 	return BRASERO_BURN_OK;
 }
 
+/**
+ * brasero_track_image_get_source:
+ * @track: a #BraseroTrackImage
+ * @uri: a #gboolean
+ *
+ * This function returns the path or the URI (if @uri is TRUE) of the
+ * source image file.
+ *
+ * Return value: a #gchar
+ **/
+
 gchar *
 brasero_track_image_get_source (BraseroTrackImage *track,
 				gboolean uri)
@@ -190,6 +224,17 @@ brasero_track_image_get_source (BraseroTrackImage *track,
 		return brasero_string_get_localpath (priv->image);
 }
 
+/**
+ * brasero_track_image_get_toc_source:
+ * @track: a #BraseroTrackImage
+ * @uri: a #gboolean
+ *
+ * This function returns the path or the URI (if @uri is TRUE) of the
+ * source toc file.
+ *
+ * Return value: a #gchar
+ **/
+
 gchar *
 brasero_track_image_get_toc_source (BraseroTrackImage *track,
 				    gboolean uri)
@@ -207,6 +252,16 @@ brasero_track_image_get_toc_source (BraseroTrackImage *track,
 		return brasero_string_get_localpath (priv->toc);
 }
 
+/**
+ * brasero_track_image_get_format:
+ * @track: a #BraseroTrackImage
+ *
+ * This function returns the format of the
+ * source image.
+ *
+ * Return value: a #BraseroImageFormat
+ **/
+
 BraseroImageFormat
 brasero_track_image_get_format (BraseroTrackImage *track)
 {
@@ -309,6 +364,14 @@ brasero_track_image_class_init (BraseroTrackImageClass *klass)
 	klass->set_block_num = brasero_track_image_set_block_num_real;
 }
 
+/**
+ * brasero_track_image_new:
+ *
+ *  Creates a new #BraseroTrackImage object.
+ *
+ * Return value: a #BraseroTrackImage object.
+ **/
+
 BraseroTrackImage *
 brasero_track_image_new (void)
 {
diff --git a/libbrasero-burn/brasero-track-stream-cfg.c b/libbrasero-burn/brasero-track-stream-cfg.c
index f5cc388..f405daa 100644
--- a/libbrasero-burn/brasero-track-stream-cfg.c
+++ b/libbrasero-burn/brasero-track-stream-cfg.c
@@ -393,6 +393,14 @@ brasero_track_stream_cfg_class_init (BraseroTrackStreamCfgClass *klass)
 	parent_class->set_source = brasero_track_stream_cfg_set_source;
 }
 
+/**
+ * brasero_track_stream_cfg_new:
+ *
+ *  Creates a new #BraseroTrackStreamCfg object.
+ *
+ * Return value: a #BraseroTrackStreamCfg object.
+ **/
+
 BraseroTrackStreamCfg *
 brasero_track_stream_cfg_new (void)
 {
diff --git a/libbrasero-burn/brasero-track-stream.c b/libbrasero-burn/brasero-track-stream.c
index 3367cf5..9ea4687 100644
--- a/libbrasero-burn/brasero-track-stream.c
+++ b/libbrasero-burn/brasero-track-stream.c
@@ -72,6 +72,16 @@ brasero_track_stream_set_source_real (BraseroTrackStream *track,
 	return BRASERO_BURN_OK;
 }
 
+/**
+ * brasero_track_stream_set_source:
+ * @track: a #BraseroTrackStream
+ * @uri: a #gchar
+ *
+ * Sets the stream (song or video) uri. 
+ *
+ * Return value: a #BraseroBurnResult. BRASERO_BURN_OK if it is successful.
+ **/
+
 BraseroBurnResult
 brasero_track_stream_set_source (BraseroTrackStream *track,
 				 const gchar *uri)
@@ -93,6 +103,15 @@ brasero_track_stream_set_source (BraseroTrackStream *track,
 	return BRASERO_BURN_OK;
 }
 
+/**
+ * brasero_track_stream_get_format:
+ * @track: a #BraseroTrackStream
+ *
+ * This function returns the format of the stream.
+ *
+ * Return value: a #BraseroStreamFormat.
+ **/
+
 BraseroStreamFormat
 brasero_track_stream_get_format (BraseroTrackStream *track)
 {
@@ -120,6 +139,16 @@ brasero_track_stream_set_format_real (BraseroTrackStream *track,
 	return BRASERO_BURN_OK;
 }
 
+/**
+ * brasero_track_stream_set_format:
+ * @track: a #BraseroTrackStream
+ * @format: a #BraseroStreamFormat
+ *
+ * Sets the format of the stream.
+ *
+ * Return value: a #BraseroBurnResult. BRASERO_BURN_OK if it is successful.
+ **/
+
 BraseroBurnResult
 brasero_track_stream_set_format (BraseroTrackStream *track,
 				 BraseroStreamFormat format)
@@ -163,6 +192,19 @@ brasero_track_stream_set_boundaries_real (BraseroTrackStream *track,
 	return BRASERO_BURN_OK;
 }
 
+/**
+ * brasero_track_stream_set_boundaries:
+ * @track: a #BraseroTrackStream
+ * @start: a #gint64 or -1 to ignore
+ * @end: a #gint64 or -1 to ignore
+ * @gap: a #gint64 or -1 to ignore
+ *
+ * Sets the boundaries of the stream (where it starts, ends in the file;
+ * how long is the gap with the next track) in nano seconds.
+ *
+ * Return value: a #BraseroBurnResult. BRASERO_BURN_OK if it is successful.
+ **/
+
 BraseroBurnResult
 brasero_track_stream_set_boundaries (BraseroTrackStream *track,
 				     gint64 start,
@@ -186,6 +228,17 @@ brasero_track_stream_set_boundaries (BraseroTrackStream *track,
 	return BRASERO_BURN_OK;
 }
 
+/**
+ * brasero_track_stream_get_source:
+ * @track: a #BraseroTrackStream
+ * @uri: a #gboolean
+ *
+ * This function returns the path or the URI (if @uri is TRUE)
+ * of the stream (song or video file).
+ *
+ * Return value: a #gchar.
+ **/
+
 gchar *
 brasero_track_stream_get_source (BraseroTrackStream *track,
 				 gboolean uri)
@@ -201,6 +254,15 @@ brasero_track_stream_get_source (BraseroTrackStream *track,
 		return brasero_string_get_localpath (priv->uri);
 }
 
+/**
+ * brasero_track_stream_get_gap:
+ * @track: a #BraseroTrackStream
+ *
+ * This function returns length of the gap (in nano seconds).
+ *
+ * Return value: a #guint64.
+ **/
+
 guint64
 brasero_track_stream_get_gap (BraseroTrackStream *track)
 {
@@ -212,6 +274,15 @@ brasero_track_stream_get_gap (BraseroTrackStream *track)
 	return priv->gap;
 }
 
+/**
+ * brasero_track_stream_get_start:
+ * @track: a #BraseroTrackStream
+ *
+ * This function returns start time in the stream (in nano seconds).
+ *
+ * Return value: a #guint64.
+ **/
+
 guint64
 brasero_track_stream_get_start (BraseroTrackStream *track)
 {
@@ -223,6 +294,15 @@ brasero_track_stream_get_start (BraseroTrackStream *track)
 	return priv->start;
 }
 
+/**
+ * brasero_track_stream_get_end:
+ * @track: a #BraseroTrackStream
+ *
+ * This function returns end time in the stream (in nano seconds).
+ *
+ * Return value: a #guint64.
+ **/
+
 guint64
 brasero_track_stream_get_end (BraseroTrackStream *track)
 {
@@ -234,6 +314,18 @@ brasero_track_stream_get_end (BraseroTrackStream *track)
 	return priv->end;
 }
 
+/**
+ * brasero_track_stream_get_length:
+ * @track: a #BraseroTrackStream
+ * @length: a #guint64
+ *
+ * This function returns the length of the stream (in nano seconds)
+ * taking into account the start and end time as well as the length
+ * of the gap. It stores it in @length.
+ *
+ * Return value: a #BraseroBurnResult. BRASERO_BURN_OK if @length was set.
+ **/
+
 BraseroBurnResult
 brasero_track_stream_get_length (BraseroTrackStream *track,
 				 guint64 *length)
@@ -365,6 +457,14 @@ brasero_track_stream_class_init (BraseroTrackStreamClass *klass)
 	klass->set_boundaries = brasero_track_stream_set_boundaries_real;
 }
 
+/**
+ * brasero_track_stream_new:
+ *
+ *  Creates a new #BraseroTrackStream object.
+ *
+ * Return value: a #BraseroTrackStream object.
+ **/
+
 BraseroTrackStream *
 brasero_track_stream_new (void)
 {
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]