gplugin/gplugin

Update plugin docs to not suck
feature/gtk-doc
2017-07-31, Gary Kramlich
16ef62748daf
Parents 0a7ae375f787
Children 3fc76104d688
Update plugin docs to not suck
1 files changed, 22 insertions(+), 6 deletions(-)
  • +22 -6
    gplugin/gplugin-plugin.c
    • --- a/gplugin/gplugin-plugin.c Mon Jul 31 22:18:18 2017 -0500
    +++ b/gplugin/gplugin-plugin.c Mon Jul 31 22:22:21 2017 -0500
    @@ -21,6 +21,16 @@
    #include <gplugin/gplugin-marshallers.h>
    #include <gplugin/gplugin-private.h>
    +/**
    + * SECTION:gplugin-plugin
    + * @Title: Plugin Objects
    + * @Short_description: abstract plugin implementation
    + *
    + * #GPluginPlugin is an abstract class that tracks the state of a plugin. It
    + * is subclassed by each loader for them to add additional data for their
    + * implementation.
    + */
    +
    #define GPLUGIN_PLUGIN_GET_PRIVATE(obj) \
    (G_TYPE_INSTANCE_GET_PRIVATE((obj), GPLUGIN_TYPE_PLUGIN, GPluginPluginPrivate))
    @@ -305,7 +315,9 @@
    * gplugin_plugin_get_filename:
    * @plugin: #GPluginPlugin instance
    *
    - * Return value: The filename of @plugin
    + * Returns the filename that @plugin was loaded from.
    + *
    + * Returns: The filename of @plugin
    */
    const gchar *
    gplugin_plugin_get_filename(const GPluginPlugin *plugin) {
    @@ -322,7 +334,9 @@
    * gplugin_plugin_get_loader:
    * @plugin: #GPluginPlugin instance
    *
    - * Return Value: (transfer full): The #GPluginLoader that loaded @plugin
    + * Returns the #GPluginLoader that loaded @plugin.
    + *
    + * Returns: (transfer full): The #GPluginLoader that loaded @plugin
    */
    GPluginLoader *
    gplugin_plugin_get_loader(const GPluginPlugin *plugin) {
    @@ -339,7 +353,9 @@
    * gplugin_plugin_get_info:
    * @plugin: #GPluginPlugin instance
    *
    - * Return value: (transfer full): The #GPluginPluginInfo instance for @plugin
    + * Returns the #GPluginPluginInfo for @plugin.
    + *
    + * Returns: (transfer full): The #GPluginPluginInfo instance for @plugin
    */
    GPluginPluginInfo *
    gplugin_plugin_get_info(const GPluginPlugin *plugin) {
    @@ -358,7 +374,7 @@
    *
    * Gets the current state of @plugin
    *
    - * Return value: (transfer full): The current state of @plugin
    + * Returns: (transfer full): The current state of @plugin
    */
    GPluginPluginState
    gplugin_plugin_get_state(const GPluginPlugin *plugin) {
    @@ -401,8 +417,8 @@
    *
    * Returns a list of plugins that depend on @plugin.
    *
    - * Return value: (element-type GPlugin.Plugin) (transfer none): A #GList of
    - * each plugin that depends on this plugin.
    + * Returns: (element-type GPlugin.Plugin) (transfer none): A #GList of each
    + * plugin that depends on this plugin.
    */
    GList *
    gplugin_plugin_get_dependent_plugins(const GPluginPlugin *plugin) {