gplugin/gplugin

Update a bunch more docs for a bunch more stuff
feature/gtk-doc
2017-07-31, Gary Kramlich
3fc76104d688
Parents 16ef62748daf
Children 9a04aaa24642
Update a bunch more docs for a bunch more stuff
3 files changed, 93 insertions(+), 22 deletions(-)
  • +14 -0
    gplugin/gplugin-core.c
  • +8 -0
    gplugin/gplugin-native-loader.c
  • +71 -22
    gplugin/gplugin-plugin-info.c
    • --- a/gplugin/gplugin-core.c Mon Jul 31 22:22:21 2017 -0500
    +++ b/gplugin/gplugin-core.c Mon Jul 31 22:42:40 2017 -0500
    @@ -26,6 +26,20 @@
    /******************************************************************************
    * API
    *****************************************************************************/
    +
    +/**
    + * GPLUGIN_DOMAIN: (skip)
    + *
    + * The #GError domain used internally by GPlugin
    + */
    +
    +/**
    + * GPLUGIN_GLOBAL_HEADER_INSIDE: (skip)
    + *
    + * This define is used to determine if we're inside the gplugin global header
    + * file or not.
    + */
    +
    /**
    * gplugin_init:
    *
    --- a/gplugin/gplugin-native-loader.c Mon Jul 31 22:22:21 2017 -0500
    +++ b/gplugin/gplugin-native-loader.c Mon Jul 31 22:42:40 2017 -0500
    @@ -289,6 +289,14 @@
    /******************************************************************************
    * API
    *****************************************************************************/
    +
    +/**
    + * GPLUGIN_NATIVE_PLUGIN_ABI_VERSION:
    + *
    + * The ABI version of the #GPluginNativeLoader. Your plugin should use this
    + * as the value for %abi_version when call #gplugin_plugin_info_new.
    + */
    +
    GType
    gplugin_native_loader_get_type(void) {
    static volatile gsize type_volatile = 0;
    --- a/gplugin/gplugin-plugin-info.c Mon Jul 31 22:22:21 2017 -0500
    +++ b/gplugin/gplugin-plugin-info.c Mon Jul 31 22:42:40 2017 -0500
    @@ -21,6 +21,14 @@
    #include <gplugin/gplugin-enums.h>
    #include <gplugin/gplugin-private.h>
    +/**
    + * SECTION:gplugin-plugin-info
    + * @Title: Plugin Info Objects
    + * @Short_description: information about plugins
    + *
    + * #GPluginPluginInfo holds metadata for plugins.
    + */
    +
    #define GPLUGIN_PLUGIN_INFO_GET_PRIVATE(obj) \
    (G_TYPE_INSTANCE_GET_PRIVATE((obj), GPLUGIN_TYPE_PLUGIN_INFO, GPluginPluginInfoPrivate))
    @@ -782,7 +790,9 @@
    * gplugin_plugin_info_get_id:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: The id from @info.
    + * Returns the id that the plugin identifies itself as.
    + *
    + * Returns: The id from @info.
    */
    const gchar *
    gplugin_plugin_info_get_id(const GPluginPluginInfo *info) {
    @@ -799,7 +809,10 @@
    * gplugin_plugin_info_get_abi_version:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: The abi_version from @info.
    + * Returns the ABI or Application Binary Interface version that the plugin
    + * is supposed to work against.
    + *
    + * Returns: The abi_version from @info.
    */
    guint32
    gplugin_plugin_info_get_abi_version(const GPluginPluginInfo *info) {
    @@ -816,7 +829,11 @@
    * gplugin_plugin_info_get_internal:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: Whether or not this plugin is considered an internal plugin
    + * Returns where or not this plugin is is considered an internal plugin. An
    + * internal plugin would be something like a plugin loader or another plugin
    + * that should not be shown to users.
    + *
    + * Returns: TRUE if the plugin is internal, FALSE otherwise.
    */
    gboolean
    gplugin_plugin_info_get_internal(const GPluginPluginInfo *info) {
    @@ -833,7 +850,12 @@
    * gplugin_plugin_info_get_load_on_query:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: Whether or not this plugin should be loaded when queried
    + * Returns whether or not this plugin should be loaded when queried. This is
    + * useful for internal plugins that are adding functionality and should always
    + * be turned on. The plugin loaders use this to make sure all plugins can
    + * always be loaded.
    + *
    + * Returns: TRUE if the plugin should be loaded on query, FALSE otherwise.
    */
    gboolean
    gplugin_plugin_info_get_load_on_query(const GPluginPluginInfo *info) {
    @@ -850,7 +872,9 @@
    * gplugin_plugin_info_get_name:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: The name from @info.
    + * Returns the name of the plugin as specified in @info.
    + *
    + * Returns: The name from @info.
    */
    const gchar *
    gplugin_plugin_info_get_name(const GPluginPluginInfo *info) {
    @@ -867,7 +891,9 @@
    * gplugin_plugin_info_get_version:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: The version from @info.
    + * Returns the version of the plugin as specified in @info.
    + *
    + * Returns: The version from @info.
    */
    const gchar *
    gplugin_plugin_info_get_version(const GPluginPluginInfo *info) {
    @@ -884,6 +910,9 @@
    * gplugin_plugin_info_get_version_func: (skip)
    * @info: #GPluginPluginInfo instance
    *
    + * Returns the #GPluginVersionCompareFunc used to compare versions of the
    + * plugin.
    + *
    * Returns: The #GPluginVersionCompareFunc that can compare versions of this
    * plugins.
    */
    @@ -902,7 +931,9 @@
    * gplugin_plugin_info_get_license_id:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: The license-id from @info.
    + * Returns the liences id for the plugin as specified in @info.
    + *
    + * Returns: The license-id from @info.
    */
    const gchar *
    gplugin_plugin_info_get_license_id(const GPluginPluginInfo *info) {
    @@ -919,7 +950,9 @@
    * gplugin_plugin_info_get_license_text:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: The text of the license from @info.
    + * Returns the license text for the plugin as specified in @info.
    + *
    + * Returns: The text of the license from @info.
    */
    const gchar *
    gplugin_plugin_info_get_license_text(const GPluginPluginInfo *info) {
    @@ -936,7 +969,9 @@
    * gplugin_plugin_info_get_license_url:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: The url of the license from @info.
    + * Returns the url of the license for the plugin as specified in @info
    + *
    + * Returns: The url of the license from @info.
    */
    const gchar *
    gplugin_plugin_info_get_license_url(const GPluginPluginInfo *info) {
    @@ -953,7 +988,9 @@
    * gplugin_plugin_info_get_icon:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: The icon from @info.
    + * Returns the name of the icon for the plugin as specified in @info.
    + *
    + * Returns: The icon from @info.
    */
    const gchar *
    gplugin_plugin_info_get_icon(const GPluginPluginInfo *info) {
    @@ -970,7 +1007,9 @@
    * gplugin_plugin_info_get_summary:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: The summary from @info.
    + * Returns the summery for the plugin as specified in @info.
    + *
    + * Returns: The summary from @info.
    */
    const gchar *
    gplugin_plugin_info_get_summary(const GPluginPluginInfo *info) {
    @@ -987,7 +1026,9 @@
    * gplugin_plugin_info_get_description:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: The description from @info.
    + * Returns the description for the plugin as specified in @info.
    + *
    + * Returns: The description from @info.
    */
    const gchar *
    gplugin_plugin_info_get_description(const GPluginPluginInfo *info) {
    @@ -1004,7 +1045,9 @@
    * gplugin_plugin_info_get_category:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: The category from @info.
    + * Returns the category of the plugin as specified in @info.
    + *
    + * Returns: The category from @info.
    */
    const gchar *
    gplugin_plugin_info_get_category(const GPluginPluginInfo *info) {
    @@ -1021,8 +1064,9 @@
    * gplugin_plugin_info_get_authors:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: (array zero-terminated=1) (transfer none): The authors from
    - * @info.
    + * Returns the authors of the plugin as specified in @info.
    + *
    + * Returns: (array zero-terminated=1) (transfer none): The authors from @info.
    */
    const gchar * const *
    gplugin_plugin_info_get_authors(const GPluginPluginInfo *info) {
    @@ -1039,7 +1083,9 @@
    * gplugin_plugin_info_get_help:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: The help from @info.
    + * Returns the help text for the plugin as specified in @info.
    + *
    + * Returns: The help from @info.
    */
    const gchar *
    gplugin_plugin_info_get_help(const GPluginPluginInfo *info) {
    @@ -1056,7 +1102,9 @@
    * gplugin_plugin_info_get_website:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: The website from @info.
    + * Returns the website for the plugin as specified in @info.
    + *
    + * Returns: The website from @info.
    */
    const gchar *
    gplugin_plugin_info_get_website(const GPluginPluginInfo *info) {
    @@ -1073,8 +1121,10 @@
    * gplugin_plugin_info_get_dependencies:
    * @info: #GPluginPluginInfo instance
    *
    - * Return value: (array zero-terminated=1) (transfer none): The list of
    - * dependencies from @info.
    + * Returns the dependencies of the plugins as specified in @info.
    + *
    + * Returns: (array zero-terminated=1) (transfer none): The list of
    + * dependencies from @info.
    */
    const gchar * const *
    gplugin_plugin_info_get_dependencies(const GPluginPluginInfo *info) {
    @@ -1093,9 +1143,8 @@
    *
    * This function is only used by the native plugin loader.
    *
    - * Return value: TRUE if the plugin has requested to be loaded with it's
    - * symbols bound locally, FALSE if they should bind be bound
    - * globally.
    + * Returns: TRUE if the plugin has requested to be loaded with it's symbols
    + * bound locally, FALSE if they should bind be bound globally.
    */
    gboolean
    gplugin_plugin_info_get_bind_local(const GPluginPluginInfo *info) {