summaryrefslogtreecommitdiff
path: root/libpeas/peas-extension-base.c
diff options
context:
space:
mode:
authorSteve Frécinaux <code@istique.net>2010-05-29 15:43:41 +0200
committerSteve Frécinaux <code@istique.net>2010-05-29 15:43:41 +0200
commit019575ec6a7bc6c5b139845122776a376f58e0d6 (patch)
treedd46c0bdb132501c8dc50d77154d25b5c8714567 /libpeas/peas-extension-base.c
parente00bad8b6c867d2610a445e5ab58282ce8530c11 (diff)
downloadlibpeas-019575ec6a7bc6c5b139845122776a376f58e0d6.tar.gz
Update documentation for most classes of libpeas.
Diffstat (limited to 'libpeas/peas-extension-base.c')
-rw-r--r--libpeas/peas-extension-base.c22
1 files changed, 9 insertions, 13 deletions
diff --git a/libpeas/peas-extension-base.c b/libpeas/peas-extension-base.c
index 3639bec..135645e 100644
--- a/libpeas/peas-extension-base.c
+++ b/libpeas/peas-extension-base.c
@@ -29,22 +29,18 @@
#include "peas-dirs.h"
/**
- * SECTION:peas-plugin
- * @short_description: Base class for plugins
+ * SECTION:peas-extension-base
+ * @short_description: Base class for C extensions
* @see_also: #PeasPluginInfo
*
- * A #PeasExtensionBase is an object which represents an actual loaded plugin.
+ * #PeasExtensionBase can optionally be used as a base class for the extensions
+ * of your plugin. By inheriting from it, you will make your extension able to
+ * access the related #PeasPluginInfo, and especially the location where all
+ * the data of your plugin lives.
*
- * As a plugin writer, you will need to inherit from this class to perform
- * the actions you want to using the available hooks. It will also provide
- * you a few useful pieces of information, like the location where all your
- * data lives.
- *
- * As an application developper, you might want to provide a subclass of
- * #PeasExtensionBase for tighter integration with your application. But you should
- * not use this class at all in your application code apart from that, as all
- * the actions that can be performed by plugins will be proxied by the
- * #PeasEngine.
+ * Non-C extensions will usually not inherit from this class: Python and Seed
+ * ones automatically get a "plugin_info" attribute that serves the same
+ * purpose.
**/
G_DEFINE_ABSTRACT_TYPE (PeasExtensionBase, peas_extension_base, G_TYPE_OBJECT);