gplugin/gplugin

Fix up the gplugin-gtk docs to be full covered
bugfix/docs-cleanup
2019-08-15, Gary Kramlich
936498b316f1
Parents 7bf98249aa24
Children ebea1f4d73fa
Fix up the gplugin-gtk docs to be full covered
5 files changed, 53 insertions(+), 5 deletions(-)
  • +12 -0
    gplugin-gtk/gplugin-gtk-plugin-info.c
  • +21 -0
    gplugin-gtk/gplugin-gtk-store.c
  • +2 -0
    gplugin-gtk/gplugin-gtk-store.h
  • +13 -0
    gplugin-gtk/gplugin-gtk-view.c
  • +5 -5
    gplugin-gtk/reference/meson.build
    • --- a/gplugin-gtk/gplugin-gtk-plugin-info.c Thu Aug 15 21:56:36 2019 -0500
    +++ b/gplugin-gtk/gplugin-gtk-plugin-info.c Thu Aug 15 22:33:00 2019 -0500
    @@ -27,6 +27,18 @@
    * #GPluginGtkPluginInfo is a Gtk+ widget that shows information about plugins.
    */
    +/**
    + * GPLUGIN_GTK_TYPE_PLUGIN_INFO:
    + *
    + * The standard _get_type macro for #GPluginGtkPluginInfo.
    + */
    +
    +/**
    + * GPluginGtkPluginInfo:
    + *
    + * A widget that displays a #GPluginPluginInfo in a user friendly way.
    + */
    +
    /******************************************************************************
    * Structs
    *****************************************************************************/
    --- a/gplugin-gtk/gplugin-gtk-store.c Thu Aug 15 21:56:36 2019 -0500
    +++ b/gplugin-gtk/gplugin-gtk-store.c Thu Aug 15 22:33:00 2019 -0500
    @@ -27,6 +27,27 @@
    * #GPluginGtkStore is a GtkTreeModel populated with gplugins.
    */
    +/**
    + * GPLUGIN_GTK_TYPE_STORE:
    + *
    + * The standard _get_type macro for #GPluginGtkStore.
    + */
    +
    +/**
    + * GPluginGtkStoreColumns:
    + * @GPLUGIN_GTK_STORE_LOADED_COLUMN: The loaded column.
    + * @GPLUGIN_GTK_STORE_PLUGIN_COLUMN: The plugin column.
    + * @GPLUGIN_GTK_STORE_MARKUP_COLUMN: The markup column.
    + *
    + * An enum declaring the columns in a #GPluginGtkStore.
    + */
    +
    +/**
    + * GPluginGtkStore:
    + *
    + * A #GtkTreeStore that contains all of the known plugins in GPlugin.
    + */
    +
    struct _GPluginGtkStore {
    GtkListStore parent;
    };
    --- a/gplugin-gtk/gplugin-gtk-store.h Thu Aug 15 21:56:36 2019 -0500
    +++ b/gplugin-gtk/gplugin-gtk-store.h Thu Aug 15 22:33:00 2019 -0500
    @@ -36,6 +36,8 @@
    GPLUGIN_GTK_STORE_LOADED_COLUMN,
    GPLUGIN_GTK_STORE_PLUGIN_COLUMN,
    GPLUGIN_GTK_STORE_MARKUP_COLUMN,
    +
    + /*< private >*/
    GPLUGIN_GTK_STORE_N_COLUMNS,
    } GPluginGtkStoreColumns;
    --- a/gplugin-gtk/gplugin-gtk-view.c Thu Aug 15 21:56:36 2019 -0500
    +++ b/gplugin-gtk/gplugin-gtk-view.c Thu Aug 15 22:33:00 2019 -0500
    @@ -26,6 +26,19 @@
    * #GPluginGtkView is a display widget for a list of GPlugins.
    */
    +/**
    + * GPLUGIN_GTK_TYPE_VIEW:
    + *
    + * The standard _get_type macro for #GPluginGtkView.
    + */
    +
    +/**
    + * GPluginGtkView:
    + *
    + * A #GtkTreeView widget that displays all the plugins and some basic
    + * information about them.
    + */
    +
    /******************************************************************************
    * Structs
    *****************************************************************************/
    --- a/gplugin-gtk/reference/meson.build Thu Aug 15 21:56:36 2019 -0500
    +++ b/gplugin-gtk/reference/meson.build Thu Aug 15 22:33:00 2019 -0500
    @@ -3,6 +3,7 @@
    # Header files or dirs to ignore when scanning. Use base file/dir names
    ignore_hfiles = [
    'gplugin-gtk.h',
    + 'gplugin-gtk-resources.h',
    ]
    ignore_hfiles += GPLUGIN_GTK_PRIVATE_HEADERS
    @@ -11,12 +12,10 @@
    '--deprecated-guards=GPLUGIN_GTK_DISABLE_DEPRECATED',
    '--rebuild-types',
    '--rebuild-sections',
    - '--ignore-headers=' + ' '.join(ignore_hfiles),
    ]
    -# Extra options to supply to gtkdoc-mkdb.
    -mkdb_args = [
    - '--ignore-files=' + ' '.join(ignore_hfiles),
    +fixxref_args = [
    + '--extra-dir', join_paths(meson.current_build_dir(), '../../gplugin/reference')
    ]
    gplugin_gtk_version_xml = configure_file(
    @@ -31,9 +30,10 @@
    main_xml : DOC_MODULE + '-docs.xml',
    src_dir : gplugin_gtk_inc,
    dependencies : gplugin_gtk_dep,
    + ignore_headers : ignore_hfiles,
    install : true,
    scan_args : scan_args,
    - mkdb_args : mkdb_args,
    gobject_typesfile : DOC_MODULE + '.types',
    content_files : content_files,
    + fixxref_args : fixxref_args,
    )