Commit 59b7dc80 authored by Ignacio Casal Quinteiro's avatar Ignacio Casal Quinteiro Committed by Ignacio Casal Quinteiro

Added documentation.

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.


svn path=/trunk/; revision=6448
parent 55ce3b2a
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.
2008-08-24 Paolo Borelli <pborelli@katamail.com>
* gedit/gedit-document.c (_gedit_document_check_externally_modified):
......
......@@ -202,6 +202,10 @@ gedit_plugin_get_type
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>
......
......@@ -72,6 +72,13 @@ gedit_plugin_init (GeditPlugin *plugin)
/* 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_activate (GeditPlugin *plugin,
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_deactivate (GeditPlugin *plugin,
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_update_ui (GeditPlugin *plugin,
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 @@ gedit_plugin_is_configurable (GeditPlugin *plugin)
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)
{
......
......@@ -112,10 +112,10 @@ gboolean gedit_plugin_is_configurable (GeditPlugin *plugin);
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 @@ register_gedit_plugin (GTypeModule *module) \
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 @@ object_name##_register_type (GTypeModule *module) \
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, ;)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment