gedit r6448 - in trunk: . docs/reference gedit

[icq svn gnome org]

Author: icq
Date: Mon Aug 25 10:28:33 2008
New Revision: 6448
URL: http://svn.gnome.org/viewvc/gedit?rev=6448&view=rev

Log:
2008-08-25  Ignacio Casal Quinteiro  <nacho resa gmail com>

        * docs/reference/gedit-sections.txt:
        * gedit/gedit-plugin.c:
        * gedit/gedit-plugin.h:
        Added documentation.



Modified:
   trunk/ChangeLog
   trunk/docs/reference/gedit-sections.txt
   trunk/gedit/gedit-plugin.c
   trunk/gedit/gedit-plugin.h

Modified: trunk/docs/reference/gedit-sections.txt
==============================================================================
--- trunk/docs/reference/gedit-sections.txt	(original)
+++ trunk/docs/reference/gedit-sections.txt	Mon Aug 25 10:28:33 2008
@@ -202,6 +202,10 @@
 GEDIT_PLUGIN_CLASS
 GEDIT_IS_PLUGIN_CLASS
 GEDIT_PLUGIN_GET_CLASS
+GEDIT_PLUGIN_REGISTER_TYPE_WITH_CODE
+GEDIT_PLUGIN_REGISTER_TYPE
+GEDIT_PLUGIN_DEFINE_TYPE_WITH_CODE
+GEDIT_PLUGIN_DEFINE_TYPE
 </SECTION>
 
 <SECTION>

Modified: trunk/gedit/gedit-plugin.c
==============================================================================
--- trunk/gedit/gedit-plugin.c	(original)
+++ trunk/gedit/gedit-plugin.c	Mon Aug 25 10:28:33 2008
@@ -72,6 +72,13 @@
 	/* Empty */
 }
 
+/**
+ * gedit_plugin_activate:
+ * @plugin: a #GeditPlugin
+ * @window: a #GeditWindow
+ * 
+ * Activates the plugin.
+ */
 void
 gedit_plugin_activate (GeditPlugin *plugin,
 		       GeditWindow *window)
@@ -82,6 +89,13 @@
 	GEDIT_PLUGIN_GET_CLASS (plugin)->activate (plugin, window);
 }
 
+/**
+ * gedit_plugin_deactivate:
+ * @plugin: a #GeditPlugin
+ * @window: a #GeditWindow
+ * 
+ * Deactivates the plugin.
+ */
 void
 gedit_plugin_deactivate	(GeditPlugin *plugin,
 			 GeditWindow *window)
@@ -91,7 +105,15 @@
 
 	GEDIT_PLUGIN_GET_CLASS (plugin)->deactivate (plugin, window);
 }
-				 
+
+/**
+ * gedit_plugin_update_ui:
+ * @plugin: a #GeditPlugin
+ * @window: a #GeditWindow
+ *
+ * Triggers an update of the user interface to take into account state changes
+ * caused by the plugin.
+ */		 
 void
 gedit_plugin_update_ui	(GeditPlugin *plugin,
 			 GeditWindow *window)
@@ -102,6 +124,14 @@
 	GEDIT_PLUGIN_GET_CLASS (plugin)->update_ui (plugin, window);
 }
 
+/**
+ * gedit_plugin_is_configurable:
+ * @plugin: a #GeditPlugin
+ *
+ * Whether the plugin is configurable.
+ *
+ * Returns: TRUE if the plugin is configurable:
+ */
 gboolean
 gedit_plugin_is_configurable (GeditPlugin *plugin)
 {
@@ -110,6 +140,14 @@
 	return GEDIT_PLUGIN_GET_CLASS (plugin)->is_configurable (plugin);
 }
 
+/**
+ * gedit_plugin_create_configure_dialog:
+ * @plugin: a #GeditPlugin
+ *
+ * Creates the configure dialog widget for the plugin.
+ *
+ * Returns: the configure dialog widget for the plugin.
+ */
 GtkWidget *
 gedit_plugin_create_configure_dialog (GeditPlugin *plugin)
 {

Modified: trunk/gedit/gedit-plugin.h
==============================================================================
--- trunk/gedit/gedit-plugin.h	(original)
+++ trunk/gedit/gedit-plugin.h	Mon Aug 25 10:28:33 2008
@@ -112,10 +112,10 @@
 GtkWidget	*gedit_plugin_create_configure_dialog		
 						(GeditPlugin *plugin);
 
-/*
- * Utility macro used to register plugins
+/**
+ * GEDIT_PLUGIN_REGISTER_TYPE_WITH_CODE(PluginName, plugin_name, CODE):
  *
- * use: GEDIT_PLUGIN_REGISTER_TYPE_WITH_CODE(PluginName, plugin_name, CODE)
+ * Utility macro used to register plugins with additional code.
  */
 #define GEDIT_PLUGIN_REGISTER_TYPE_WITH_CODE(PluginName, plugin_name, CODE)	\
 										\
@@ -169,18 +169,18 @@
 	return plugin_name##_type;						\
 }
 
-/*
- * Utility macro used to register plugins
- *
- * use: GEDIT_PLUGIN_REGISTER_TYPE(PluginName, plugin_name)
+/**
+ * GEDIT_PLUGIN_REGISTER_TYPE(PluginName, plugin_name):
+ * 
+ * Utility macro used to register plugins.
  */
 #define GEDIT_PLUGIN_REGISTER_TYPE(PluginName, plugin_name)			\
 	GEDIT_PLUGIN_REGISTER_TYPE_WITH_CODE(PluginName, plugin_name, ;)
 
-/*
- * Utility macro used to register gobject types in plugins with additional code
+/**
+ * GEDIT_PLUGIN_DEFINE_TYPE_WITH_CODE(ObjectName, object_name, PARENT_TYPE, CODE):
  *
- * use: GEDIT_PLUGIN_DEFINE_TYPE_WITH_CODE(ObjectName, object_name, PARENT_TYPE, CODE)
+ * Utility macro used to register gobject types in plugins with additional code.
  */
 #define GEDIT_PLUGIN_DEFINE_TYPE_WITH_CODE(ObjectName, object_name, PARENT_TYPE, CODE)	\
 										\
@@ -230,10 +230,10 @@
 	return g_define_type_id;						\
 }
 
-/*
- * Utility macro used to register gobject types in plugins
+/**
+ * GEDIT_PLUGIN_DEFINE_TYPE(ObjectName, object_name, PARENT_TYPE):
  *
- * use: GEDIT_PLUGIN_DEFINE_TYPE(ObjectName, object_name, PARENT_TYPE)
+ * Utility macro used to register gobject types in plugins.
  */
 #define GEDIT_PLUGIN_DEFINE_TYPE(ObjectName, object_name, PARENT_TYPE)		\
 	GEDIT_PLUGIN_DEFINE_TYPE_WITH_CODE(ObjectName, object_name, PARENT_TYPE, ;)