[brasero] Add API documentation for one function



commit cf62e04485e9e226ad7aadee687168a536237e79
Author: Philippe Rouquier <bonfire-app wanadoo fr>
Date:   Fri Jul 31 14:08:17 2009 +0200

    Add API documentation for one function

 libbrasero-burn/brasero-caps-session.c |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)
---
diff --git a/libbrasero-burn/brasero-caps-session.c b/libbrasero-burn/brasero-caps-session.c
index b111394..99f9434 100644
--- a/libbrasero-burn/brasero-caps-session.c
+++ b/libbrasero-burn/brasero-caps-session.c
@@ -661,6 +661,16 @@ brasero_burn_session_input_supported (BraseroBurnSession *session,
 	return BRASERO_BURN_OK;
 }
 
+/**
+ * brasero_burn_session_output_supported:
+ * @session: a #BraseroBurnSession *
+ * @output: a #BraseroTrackType *
+ *
+ * Make sure that the image type or medium type defined in @output can be
+ * created/burnt given the parameters set in @session.
+ *
+ * Return value: BRASERO_BURN_OK if the medium type or the image type can be used as an output.
+ **/
 BraseroBurnResult
 brasero_burn_session_output_supported (BraseroBurnSession *session,
 				       BraseroTrackType *output)



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