anjuta r4217 - in trunk: . libanjuta manuals/reference/libanjuta

[sgranjoux svn gnome org]

Author: sgranjoux
Date: Tue Sep  2 20:14:10 2008
New Revision: 4217
URL: http://svn.gnome.org/viewvc/anjuta?rev=4217&view=rev

Log:
	* libanjuta/anjuta-message-area.c,
	manuals/reference/libanjuta/libanjuta-docs.sgml,
	manuals/reference/libanjuta/libanjuta-sections.txt:
	Added documentation.


Modified:
   trunk/ChangeLog
   trunk/libanjuta/anjuta-message-area.c
   trunk/manuals/reference/libanjuta/libanjuta-docs.sgml
   trunk/manuals/reference/libanjuta/libanjuta-sections.txt

Modified: trunk/libanjuta/anjuta-message-area.c
==============================================================================
--- trunk/libanjuta/anjuta-message-area.c	(original)
+++ trunk/libanjuta/anjuta-message-area.c	Tue Sep  2 20:14:10 2008
@@ -258,6 +258,13 @@
 	anjuta_message_area_response (message_area, response_id);
 }
 
+/**
+ * anjuta_message_area_set_text:
+ * @message_area: an #AnjutaMessageArea
+ * @text: the text to set in the message area
+ *
+ * Sets the visualized text of the #AnjutaMessageArea.
+ */
 void
 anjuta_message_area_set_text (AnjutaMessageArea *message_area,
                               const gchar *text)
@@ -272,6 +279,13 @@
 	}
 }
 
+/**
+ * anjuta_message_area_set_image:
+ * @message_area: an #AnjutaMessageArea
+ * @icon_stock_id: a stock image ID
+ *
+ * Sets the visualized icon of the #AnjutaMessageArea.
+ */
 void
 anjuta_message_area_set_image (AnjutaMessageArea *message_area,
                                const gchar *icon_stock_id)
@@ -315,6 +329,13 @@
 	                             0);
 }
 
+/**
+ * anjuta_message_area_new:
+ * 
+ * Creates a new #AnjutaMessageArea object.
+ * 
+ * Returns: a new #AnjutaMessageArea object
+ */
 GtkWidget *
 anjuta_message_area_new (const gchar    *text,
                          const gchar    *icon_stock_id)
@@ -327,6 +348,14 @@
 	
 	return GTK_WIDGET (message_area);
 }
+
+/**
+ * anjuta_message_area_response:
+ * @message_area: an #AnjutaMessageArea
+ * @response_id: a response ID
+ *
+ * Emits the 'response' signal with the given @response_id.
+ */
 void
 anjuta_message_area_response (AnjutaMessageArea *message_area,
 							  gint			   response_id)
@@ -339,6 +368,19 @@
 				   response_id);
 }
 
+/**
+ * anjuta_message_area_add_button:
+ * @message_area: an #AnjutaMessageArea
+ * @button_text: text of button, or stock ID
+ * @response_id: response ID for the button
+ * 
+ * Adds a button with the given text (or a stock button, if button_text is a stock ID)
+ * and sets things up so that clicking the button will emit the "response" signal
+ * with the given response_id. The button is appended to the end of the message area's
+ * action area. The button widget is returned, but usually you don't need it.
+ *
+ * Returns: the button widget that was added
+ */
 GtkWidget*
 anjuta_message_area_add_button (AnjutaMessageArea *message_area,
 								const gchar       *button_text,
@@ -362,6 +404,15 @@
 	return button;
 }
 
+/**
+ * anjuta_message_area_add_button_with_stock_image:
+ * @message_area: an #AnjutaMessageArea
+ * @text: the text to visualize in the button
+ * @stock_id: the stock ID of the button
+ * @response_id: a response ID
+ *
+ * Same as anjuta_message_area_add_button() but with a specific icon.
+ */
 GtkWidget *
 anjuta_message_area_add_button_with_stock_image (AnjutaMessageArea *message_area,
                                                  const gchar	   *text,

Modified: trunk/manuals/reference/libanjuta/libanjuta-docs.sgml
==============================================================================
--- trunk/manuals/reference/libanjuta/libanjuta-docs.sgml	(original)
+++ trunk/manuals/reference/libanjuta/libanjuta-docs.sgml	Tue Sep  2 20:14:10 2008
@@ -72,6 +72,7 @@
     <xi:include href="xml/anjuta-error.xml"/>
     <xi:include href="xml/anjuta-command.xml"/>
     <xi:include href="xml/anjuta-async-command.xml"/>
+    <xi:include href="xml/anjuta-message-area.xml"/>
   </chapter>
   
   <chapter id="libanjuta-internal-api">

Modified: trunk/manuals/reference/libanjuta/libanjuta-sections.txt
==============================================================================
--- trunk/manuals/reference/libanjuta/libanjuta-sections.txt	(original)
+++ trunk/manuals/reference/libanjuta/libanjuta-sections.txt	Tue Sep  2 20:14:10 2008
@@ -605,6 +605,41 @@
 </SECTION>
 
 <SECTION>
+<FILE>anjuta-message-area</FILE>
+AnjutaMessageAreaPrivate
+<TITLE>AnjutaMessageArea</TITLE>
+AnjutaMessageArea
+anjuta_message_area_new
+anjuta_message_area_set_text
+anjuta_message_area_set_image
+anjuta_message_area_add_button
+anjuta_message_area_add_button_with_stock_image
+anjuta_message_area_response
+<SUBSECTION Standard>
+ANJUTA_MESSAGE_AREA
+ANJUTA_IS_MESSAGE_AREA
+ANJUTA_TYPE_MESSAGE_AREA
+anjuta_message_area_get_type
+ANJUTA_MESSAGE_AREA_CLASS
+ANJUTA_IS_MESSAGE_AREA_CLASS
+ANJUTA_MESSAGE_AREA_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>anjuta-sync-command</FILE>
+<TITLE>AnjutaSyncCommand</TITLE>
+AnjutaSyncCommand
+<SUBSECTION Standard>
+ANJUTA_SYNC_COMMAND
+ANJUTA_IS_SYNC_COMMAND
+ANJUTA_TYPE_SYNC_COMMAND
+anjuta_sync_command_get_type
+ANJUTA_SYNC_COMMAND_CLASS
+ANJUTA_IS_SYNC_COMMAND_CLASS
+ANJUTA_SYNC_COMMAND_GET_CLASS
+</SECTION>
+
+<SECTION>
 <FILE>ianjuta-editor</FILE>
 IANJUTA_TYPE_EDITOR_ATTRIBUTE
 IANJUTA_TYPE_EDITOR_ERROR