[brasero] A few fixes for API documentation



commit 8951a4b476622ec748ad2f7b5e5fbfc5aff91c5e
Author: Philippe Rouquier <bonfire-app wanadoo fr>
Date:   Thu Nov 5 20:39:21 2009 +0100

    A few fixes for API documentation

 libbrasero-burn/brasero-caps-session.c |   10 +++++-----
 libbrasero-burn/brasero-track-type.c   |    4 ++--
 libbrasero-burn/burn-basics.c          |   19 +++++++++++++++++++
 3 files changed, 26 insertions(+), 7 deletions(-)
---
diff --git a/libbrasero-burn/brasero-caps-session.c b/libbrasero-burn/brasero-caps-session.c
index 37b2120..892dabb 100644
--- a/libbrasero-burn/brasero-caps-session.c
+++ b/libbrasero-burn/brasero-caps-session.c
@@ -741,14 +741,14 @@ brasero_caps_try_output_with_blanking (BraseroBurnCaps *self,
  * brasero_burn_session_input_supported:
  * @session: a #BraseroBurnSession
  * @input: a #BraseroTrackType
- * @use_flags: a #gboolean
+ * @check_flags: a #gboolean
  *
  * Given the various parameters stored in @session, this
  * function checks whether a session with the data type
  * @type could be burnt to the medium in the #BraseroDrive (set 
  * through brasero_burn_session_set_burner ()).
- * If @use_flags is TRUE, then flags are taken into account
- * and are not if it is FALSE.
+ * If @check_flags is %TRUE, then flags are taken into account
+ * and are not if it is %FALSE.
  *
  * Return value: a #BraseroBurnResult.
  * BRASERO_BURN_OK if it is possible.
@@ -1099,13 +1099,13 @@ brasero_burn_session_supported (BraseroBurnSession *session,
 /**
  * brasero_burn_session_can_burn:
  * @session: a #BraseroBurnSession
- * @use_flags: a #gboolean
+ * @check_flags: a #gboolean
  *
  * Given the various parameters stored in @session, this
  * function checks whether the data contained in @session
  * can be burnt to the medium in the #BraseroDrive (set 
  * through brasero_burn_session_set_burner ()).
- * If @flags determine the behavior of this function.
+ * If @check_flags determine the behavior of this function.
  *
  * Return value: a #BraseroBurnResult.
  * BRASERO_BURN_OK if it is possible.
diff --git a/libbrasero-burn/brasero-track-type.c b/libbrasero-burn/brasero-track-type.c
index f5ce555..8da2e29 100644
--- a/libbrasero-burn/brasero-track-type.c
+++ b/libbrasero-burn/brasero-track-type.c
@@ -299,10 +299,10 @@ brasero_track_type_get_has_image (const BraseroTrackType *type)
 }
 
 /**
- * brasero_track_type_get_has_image:
+ * brasero_track_type_get_has_stream:
  * @type: a #BraseroTrackType.
  *
- * Returns TRUE if IMAGE type (see brasero_track_stream_new ()) was set.
+ * This function returns %TRUE if IMAGE type (see brasero_track_stream_new ()) was set.
  *
  * Return value: a #gboolean
  **/
diff --git a/libbrasero-burn/burn-basics.c b/libbrasero-burn/burn-basics.c
index 91f2c80..37592e0 100644
--- a/libbrasero-burn/burn-basics.c
+++ b/libbrasero-burn/burn-basics.c
@@ -218,6 +218,7 @@ brasero_caps_list_dump (void)
  *
  * Rename to: init
  *
+ * Returns: a #gboolean
  **/
 
 gboolean
@@ -339,6 +340,15 @@ brasero_burn_library_stop (void)
 	gconf_client_remove_dir (client, "/apps/brasero", NULL);
 }
 
+/**
+ * brasero_burn_library_can_checksum:
+ *
+ * Checks whether the library can do any kind of
+ * checksum at all.
+ *
+ * Returns: a #gboolean
+ */
+
 gboolean
 brasero_burn_library_can_checksum (void)
 {
@@ -372,6 +382,15 @@ brasero_burn_library_can_checksum (void)
 	return FALSE;
 }
 
+/**
+ * brasero_burn_library_input_supported:
+ * @type: a #BraseroTrackType
+ *
+ * Checks whether @type can be used as input.
+ *
+ * Returns: a #BraseroBurnResult
+ */
+
 BraseroBurnResult
 brasero_burn_library_input_supported (BraseroTrackType *type)
 {



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