From 3a4c903eea4c06fb644f04a22021fcf1dc699e42 Mon Sep 17 00:00:00 2001
From: James Liggett <jrliggett@cox.net>
Date: Sun, 25 May 2008 15:33:55 -0700
Subject: [PATCH] Document the progress signal

---
 libanjuta/anjuta-command.c | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/libanjuta/anjuta-command.c b/libanjuta/anjuta-command.c
index e618f72f..f211c7bd 100644
--- a/libanjuta/anjuta-command.c
+++ b/libanjuta/anjuta-command.c
@@ -138,6 +138,15 @@ anjuta_command_class_init (AnjutaCommandClass *klass)
 		              G_TYPE_NONE, 1,
 		              G_TYPE_UINT);
 	
+	
+	/**
+	 * AnjutaCommand::progress:
+	 * @command: Command
+	 * @progress: Fraction of the command's task that is complete, between 0.0
+	 *			  and 1.0, inclusive.
+	 *
+	 * Notifies clients of changes in progress during command execution. 
+	 */
 	anjuta_command_signals[PROGRESS] =
 		g_signal_new ("progress",
 		              G_OBJECT_CLASS_TYPE (klass),
@@ -194,6 +203,13 @@ anjuta_command_notify_complete (AnjutaCommand *self, guint return_code)
 	ANJUTA_COMMAND_GET_CLASS (self)->notify_complete (self, return_code);
 }
 
+/**
+ * anjuta_command_notify_progress:
+ * @self: Command object.
+ * 
+ * Emits the ::progress signal. Can be used by both base classes and 
+ * commands as needed. 
+ */
 void 
 anjuta_command_notify_progress (AnjutaCommand *self, gfloat progress)
 {
-- 
2.11.4.GIT