From 97c32b8728e9e8aab0c061c6d202174ec33fc2d2 Mon Sep 17 00:00:00 2001
From: Sven Neumann <sven@gimp.org>
Date: Mon, 30 Aug 2004 19:19:02 +0000
Subject: [PATCH] added some gtk-doc comments, could be improved further.

2004-08-30  Sven Neumann  <sven@gimp.org>

	* libgimp/gimpprogress.c: added some gtk-doc comments, could be
	improved further.
---
 ChangeLog                                 |  5 +++++
 devel-docs/libgimp/tmpl/gimpprogress.sgml |  1 +
 libgimp/gimpprogress.c                    | 23 +++++++++++++++++++++++
 3 files changed, 29 insertions(+)

diff --git a/ChangeLog b/ChangeLog
index 7d39e88321..04a830b4be 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2004-08-30  Sven Neumann  <sven@gimp.org>
+
+	* libgimp/gimpprogress.c: added some gtk-doc comments, could be
+	improved further.
+
 2004-08-30  Sven Neumann  <sven@gimp.org>
 
 	* plug-ins/common/colortoalpha.c
diff --git a/devel-docs/libgimp/tmpl/gimpprogress.sgml b/devel-docs/libgimp/tmpl/gimpprogress.sgml
index d2c81795ce..0f1368ac5f 100644
--- a/devel-docs/libgimp/tmpl/gimpprogress.sgml
+++ b/devel-docs/libgimp/tmpl/gimpprogress.sgml
@@ -87,6 +87,7 @@ gimpprogress
 </para>
 
 @progress_callback: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gimp_progress_cancel ##### -->
diff --git a/libgimp/gimpprogress.c b/libgimp/gimpprogress.c
index 3d8a74bcad..44a623f8a0 100644
--- a/libgimp/gimpprogress.c
+++ b/libgimp/gimpprogress.c
@@ -56,6 +56,18 @@ static GHashTable *gimp_progress_ht = NULL;
 
 /*  public functions  */
 
+/**
+ * gimp_progress_install:
+ * @start_callback: the function to call when progress starts
+ * @end_callback:   the function to call when progress finishes
+ * @text_callback:  the function to call to change the text
+ * @value_callback: the function to call to change the value
+ * @user_data:      a pointer that is returned when uninstalling the progress
+ *
+ * Return value: the name of the temporary procedure that's been installed
+ *
+ * Since: GIMP 2.2
+ **/
 const gchar *
 gimp_progress_install (GimpProgressStartCallback start_callback,
                        GimpProgressEndCallback   end_callback,
@@ -123,6 +135,17 @@ gimp_progress_install (GimpProgressStartCallback start_callback,
   return NULL;
 }
 
+/**
+ * gimp_progress_uninstall:
+ * @progress_callback: the name of the temporary procedure to uninstall
+ *
+ * Uninstalls a temporary progress procedure that was installed using
+ * gimp_progress_install().
+ *
+ * Return value: the @user_data that was passed to gimp_progress_install().
+ *
+ * Since: GIMP 2.2
+ **/
 gpointer
 gimp_progress_uninstall (const gchar *progress_callback)
 {