[gimp] gimpprogress: Add arg descriptions to vfuncs
- From: Niels De Graef <nielsdg src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gimp] gimpprogress: Add arg descriptions to vfuncs
- Date: Fri, 8 May 2020 08:48:56 +0000 (UTC)
commit 693eeae96b7cc3362a025c22de12575ad94aebb4
Author: Niels De Graef <nielsdegraef gmail com>
Date: Fri May 8 10:39:33 2020 +0200
gimpprogress: Add arg descriptions to vfuncs
That squashes some gtk-doc warnings.
libgimp/gimpprogress.h | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
---
diff --git a/libgimp/gimpprogress.h b/libgimp/gimpprogress.h
index 113193d754..30f33f7255 100644
--- a/libgimp/gimpprogress.h
+++ b/libgimp/gimpprogress.h
@@ -29,9 +29,9 @@ G_BEGIN_DECLS
/**
* GimpProgressVtableStartFunc:
- * @message:
- * @cancelable:
- * @user_data: (closure):
+ * @message: The message to show
+ * @cancelable: Whether the procedure is cancelable
+ * @user_data: (closure): User data
*
* Starts the progress
*/
@@ -41,7 +41,7 @@ typedef void (* GimpProgressVtableStartFunc) (const gchar *message,
/**
* GimpProgressVtableEndFunc:
- * @user_data: (closure):
+ * @user_data: (closure): User data
*
* Ends the progress
*/
@@ -49,8 +49,8 @@ typedef void (* GimpProgressVtableEndFunc) (gpointer user_data);
/**
* GimpProgressVtableSetTextFunc:
- * @message:
- * @user_data: (closure):
+ * @message: The new text
+ * @user_data: (closure): User data
*
* Sets a new text on the progress.
*/
@@ -59,8 +59,8 @@ typedef void (* GimpProgressVtableSetTextFunc) (const gchar *message,
/**
* GimpProgressVtableSetValueFunc:
- * @percentage:
- * @user_data: (closure):
+ * @percentage: The progress in percent
+ * @user_data: (closure): User data
*
* Sets a new percentage on the progress.
*/
@@ -69,7 +69,7 @@ typedef void (* GimpProgressVtableSetValueFunc) (gdouble percentage,
/**
* GimpProgressVtablePulseFunc:
- * @user_data: (closure):
+ * @user_data: (closure): User data
*
* Makes the progress pulse
*/
@@ -77,7 +77,7 @@ typedef void (* GimpProgressVtablePulseFunc) (gpointer user_data);
/**
* GimpProgressVtableGetWindowFunc:
- * @user_data: (closure):
+ * @user_data: (closure): User data
*
* Returns: the ID of the window where the progress is displayed.
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]