/soc/2013/ankitkv/gobjectification: 570b35d804de: Convert docs f...
Ankit Vani
a at nevitus.org
Fri Jan 31 10:28:06 EST 2014
Changeset: 570b35d804de74a94bb07179f3e2aa748a66dc36
Author: Ankit Vani <a at nevitus.org>
Date: 2014-01-31 20:57 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/570b35d804de
Description:
Convert docs from doxygen to gtk-doc format for old plugin.h, prpl.h
diffstat:
libpurple/plugin.h | 252 ++++++++++++++++++++----------
libpurple/prpl.h | 444 ++++++++++++++++++++++++++++------------------------
2 files changed, 405 insertions(+), 291 deletions(-)
diffs (truncated from 1426 to 300 lines):
diff --git a/libpurple/plugin.h b/libpurple/plugin.h
--- a/libpurple/plugin.h
+++ b/libpurple/plugin.h
@@ -33,34 +33,38 @@
#include <gmodule.h>
#include "signals.h"
-/** Returns the GType for the PurplePlugin boxed structure */
#define PURPLE_TYPE_PLUGIN (purple_plugin_get_type())
-/** @copydoc _PurplePlugin */
typedef struct _PurplePlugin PurplePlugin;
-/** @copydoc _PurplePluginInfo */
typedef struct _PurplePluginInfo PurplePluginInfo;
-/** @copydoc _PurplePluginUiInfo */
typedef struct _PurplePluginUiInfo PurplePluginUiInfo;
-/** @copydoc _PurplePluginLoaderInfo */
typedef struct _PurplePluginLoaderInfo PurplePluginLoaderInfo;
-
-/** @copydoc _PurplePluginAction */
typedef struct _PurplePluginAction PurplePluginAction;
-typedef int PurplePluginPriority; /**< Plugin priority. */
+/**
+ * PurplePluginPriority:
+ *
+ * Plugin priority.
+ */
+typedef int PurplePluginPriority;
#include "pluginpref.h"
/**
+ * PurplePluginType:
+ * @PURPLE_PLUGIN_UNKNOWN: Unknown type.
+ * @PURPLE_PLUGIN_STANDARD: Standard plugin.
+ * @PURPLE_PLUGIN_LOADER: Loader plugin.
+ * @PURPLE_PLUGIN_PROTOCOL: Protocol plugin.
+ *
* Plugin types.
*/
typedef enum
{
- PURPLE_PLUGIN_UNKNOWN = -1, /**< Unknown type. */
- PURPLE_PLUGIN_STANDARD = 0, /**< Standard plugin. */
- PURPLE_PLUGIN_LOADER, /**< Loader plugin. */
- PURPLE_PLUGIN_PROTOCOL /**< Protocol plugin. */
+ PURPLE_PLUGIN_UNKNOWN = -1,
+ PURPLE_PLUGIN_STANDARD = 0,
+ PURPLE_PLUGIN_LOADER,
+ PURPLE_PLUGIN_PROTOCOL
} PurplePluginType;
@@ -73,6 +77,8 @@ typedef enum
#define PURPLE_PLUGIN_MAGIC 5 /* once we hit 6.0.0 I think we can remove this */
/**
+ * PurplePluginInfo:
+ *
* Detailed information about a plugin.
*
* This is used in the version 2.0 API and up.
@@ -130,6 +136,8 @@ struct _PurplePluginInfo
};
/**
+ * PurplePluginLoaderInfo:
+ *
* Extra information for loader plugins.
*/
struct _PurplePluginLoaderInfo
@@ -148,21 +156,33 @@ struct _PurplePluginLoaderInfo
};
/**
+ * PurplePlugin:
+ * @native_plugin: Native C plugin.
+ * @loaded: The loaded state.
+ * @handle: The module handle.
+ * @path: The path to the plugin.
+ * @info: The plugin information.
+ * @ipc_data: IPC data.
+ * @extra: Plugin-specific data.
+ * @unloadable: Unloadable
+ * @dependent_plugins: Plugins depending on this
+ * @ui_data: The UI data.
+ *
* A plugin handle.
*/
struct _PurplePlugin
{
- gboolean native_plugin; /**< Native C plugin. */
- gboolean loaded; /**< The loaded state. */
- void *handle; /**< The module handle. */
- char *path; /**< The path to the plugin. */
- PurplePluginInfo *info; /**< The plugin information. */
+ gboolean native_plugin;
+ gboolean loaded;
+ void *handle;
+ char *path;
+ PurplePluginInfo *info;
char *error;
- void *ipc_data; /**< IPC data. */
- void *extra; /**< Plugin-specific data. */
- gboolean unloadable; /**< Unloadable */
- GList *dependent_plugins; /**< Plugins depending on this */
- gpointer ui_data; /**< The UI data. */
+ void *ipc_data;
+ void *extra;
+ gboolean unloadable;
+ GList *dependent_plugins;
+ gpointer ui_data;
void (*_purple_reserved1)(void);
void (*_purple_reserved2)(void);
@@ -191,6 +211,11 @@ struct _PurplePluginUiInfo {
/**
+ * PurplePluginAction:
+ * @plugin: set to the owning plugin
+ * @context: NULL for plugin actions menu, set to the PurpleConnection for
+ * account actions menu
+ *
* The structure used in the actions member of PurplePluginInfo
*/
struct _PurplePluginAction {
@@ -216,6 +241,8 @@ struct _PurplePluginAction {
/**
+ * PURPLE_INIT_PLUGIN:
+ *
* Handles the initialization of modules.
*/
#if !defined(PURPLE_PLUGINS) || defined(PURPLE_STATIC_PRPL)
@@ -248,6 +275,8 @@ G_BEGIN_DECLS
/*@{*/
/**
+ * purple_plugin_get_type:
+ *
* Returns the GType for the PurplePlugin boxed structure.
* TODO Boxing of PurplePlugin is a temporary solution to having a GType for
* plugins. This should rather be a GObject instead of a GBoxed.
@@ -255,21 +284,23 @@ G_BEGIN_DECLS
GType purple_plugin_get_type(void);
/**
- * Creates a new plugin structure.
- *
+ * purple_plugin_new:
* @native: Whether or not the plugin is native.
* @path: The path to the plugin, or %NULL if statically compiled.
*
+ * Creates a new plugin structure.
+ *
* Returns: A new PurplePlugin structure.
*/
PurplePlugin *purple_plugin_new(gboolean native, const char *path);
/**
+ * purple_plugin_probe:
+ * @filename: The plugin's filename.
+ *
* Probes a plugin, retrieving the information on it and adding it to the
* list of available plugins.
*
- * @filename: The plugin's filename.
- *
* Returns: The plugin handle.
*
* @see purple_plugin_load()
@@ -278,14 +309,15 @@ PurplePlugin *purple_plugin_new(gboolean
PurplePlugin *purple_plugin_probe(const char *filename);
/**
+ * purple_plugin_register:
+ * @plugin: The plugin to register.
+ *
* Registers a plugin and prepares it for loading.
*
* This shouldn't be called by anything but the internal module code.
* Plugins should use the PURPLE_INIT_PLUGIN() macro to register themselves
* with the core.
*
- * @plugin: The plugin to register.
- *
* Returns: %TRUE if the plugin was registered successfully. Otherwise
* %FALSE is returned (this happens if the plugin does not contain
* the necessary information).
@@ -293,10 +325,11 @@ PurplePlugin *purple_plugin_probe(const
gboolean purple_plugin_register(PurplePlugin *plugin);
/**
+ * purple_plugin_load:
+ * @plugin: The plugin to load.
+ *
* Attempts to load a previously probed plugin.
*
- * @plugin: The plugin to load.
- *
* Returns: %TRUE if successful, or %FALSE otherwise.
*
* @see purple_plugin_reload()
@@ -305,10 +338,11 @@ gboolean purple_plugin_register(PurplePl
gboolean purple_plugin_load(PurplePlugin *plugin);
/**
+ * purple_plugin_unload:
+ * @plugin: The plugin handle.
+ *
* Unloads the specified plugin.
*
- * @plugin: The plugin handle.
- *
* Returns: %TRUE if successful, or %FALSE otherwise.
*
* @see purple_plugin_load()
@@ -317,6 +351,8 @@ gboolean purple_plugin_load(PurplePlugin
gboolean purple_plugin_unload(PurplePlugin *plugin);
/**
+ * purple_plugin_disable:
+ *
* Disable a plugin.
*
* This function adds the plugin to a list of plugins to "disable at the next
@@ -327,10 +363,11 @@ gboolean purple_plugin_unload(PurplePlug
void purple_plugin_disable(PurplePlugin *plugin);
/**
+ * purple_plugin_reload:
+ * @plugin: The old plugin handle.
+ *
* Reloads a plugin.
*
- * @plugin: The old plugin handle.
- *
* Returns: %TRUE if successful, or %FALSE otherwise.
*
* @see purple_plugin_load()
@@ -339,94 +376,104 @@ void purple_plugin_disable(PurplePlugin
gboolean purple_plugin_reload(PurplePlugin *plugin);
/**
+ * purple_plugin_destroy:
+ * @plugin: The plugin handle.
+ *
* Unloads a plugin and destroys the structure from memory.
- *
- * @plugin: The plugin handle.
*/
void purple_plugin_destroy(PurplePlugin *plugin);
/**
+ * purple_plugin_is_loaded:
+ * @plugin: The plugin.
+ *
* Returns whether or not a plugin is currently loaded.
*
- * @plugin: The plugin.
- *
* Returns: %TRUE if loaded, or %FALSE otherwise.
*/
gboolean purple_plugin_is_loaded(const PurplePlugin *plugin);
/**
+ * purple_plugin_is_unloadable:
+ * @plugin: The plugin.
+ *
* Returns whether or not a plugin is unloadable.
*
* If this returns %TRUE, the plugin is guaranteed to not
* be loadable. However, a return value of %FALSE does not
* guarantee the plugin is loadable.
*
- * @plugin: The plugin.
- *
* Returns: %TRUE if the plugin is known to be unloadable,\
* %FALSE otherwise
*/
gboolean purple_plugin_is_unloadable(const PurplePlugin *plugin);
/**
+ * purple_plugin_get_id:
+ * @plugin: The plugin.
+ *
* Returns a plugin's id.
*
- * @plugin: The plugin.
- *
* Returns: The plugin's id.
*/
const gchar *purple_plugin_get_id(const PurplePlugin *plugin);
/**
+ * purple_plugin_get_name:
+ * @plugin: The plugin.
More information about the Commits
mailing list