[goffice] Add API documentation for go_get_mime_type and friends



commit 5355a751b7d9908f311325ee8e3ecf4dcf7ba270
Author: Jean Brefort <jean brefort normalesup org>
Date:   Sat Jan 29 17:45:24 2011 +0100

    Add API documentation for go_get_mime_type and friends

 ChangeLog               |    4 ++++
 goffice/utils/go-file.c |   25 +++++++++++++++++++++++++
 2 files changed, 29 insertions(+), 0 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 0ed63c0..1d7c5d4 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2011-01-29  Jean Brefort  <jean brefort normalesup org>
+
+	* goffice/utils/go-file.c: add some API documentation.
+
 2011-01-26  Morten Welinder  <terra gnome org>
 
 	* goffice/utils/go-format.c (printf_engineering): New function.
diff --git a/goffice/utils/go-file.c b/goffice/utils/go-file.c
index 0c51582..a61c9a4 100644
--- a/goffice/utils/go-file.c
+++ b/goffice/utils/go-file.c
@@ -1040,6 +1040,14 @@ go_url_check_extension (gchar const *uri,
 	return res;
 }
 
+/**
+ * go_get_mime_type_for_data:
+ * @uri: the uri.
+ *
+ * returns: the mime type for the file as a newly allocated string. Needs to
+ * be freed with g_free().
+**/ 
+
 gchar *
 go_get_mime_type (gchar const *uri)
 {
@@ -1092,6 +1100,14 @@ go_get_mime_type (gchar const *uri)
 #endif
 }
 
+/**
+ * go_get_mime_type_for_data:
+ * @data: the data.
+ * @data_size: the data size
+ *
+ * returns: the mime type for the data as a newly allocated string. Needs to
+ * be freed with g_free().
+**/ 
 gchar *
 go_get_mime_type_for_data (gconstpointer data, int data_size)
 {
@@ -1124,6 +1140,15 @@ go_get_mime_type_for_data (gconstpointer data, int data_size)
 #endif
 }
 
+/**
+ * go_mime_type_get_description:
+ * @mime_type: the mime type to describe.
+ *
+ * returns: the description for the mime type as a newly allocated string.
+ * Needs to be freed with g_free(). If the description is not found, the
+ * mime type itself will be returned.
+**/ 
+
 gchar *
 go_mime_type_get_description (gchar const *mime_type)
 {



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