gplugin/gplugin

Add a doc check unit test to gplugin-gtk and fix the issues it found

5 weeks ago, Gary Kramlich
f9fd009d9ca4
Parents 972f6aaee23c
Children 7027845d098d
Add a doc check unit test to gplugin-gtk and fix the issues it found

Testing Done:
Ran the unit tests

Reviewed at https://reviews.imfreedom.org/r/3040/
4 files changed, 58 insertions(+), 1 deletions(-)
  • +20 -0
    gplugin-gtk4/gplugin-gtk-version.h
  • +3 -1
    gplugin-gtk4/gplugin-gtk-view.c
  • +24 -0
    gplugin-gtk4/reference/gplugin-gtk4.toml.in
  • +11 -0
    gplugin-gtk4/reference/meson.build
    • --- a/gplugin-gtk4/gplugin-gtk-version.h Wed Mar 20 22:34:37 2024 -0500
    +++ b/gplugin-gtk4/gplugin-gtk-version.h Wed Mar 20 23:10:34 2024 -0500
    @@ -66,6 +66,26 @@
    #endif
    /**
    + * GPLUGIN_GTK_VERSION_MIN_REQUIRED:
    + *
    + * A macro that should be defined by the user prior to including the
    + * `gplugin-gtk.h` header.
    + *
    + * The definition should be one of the predefined GPluginGtk version macros:
    + * %GPLUGIN_GTK_VERSION_0_42, %GPLUGIN_GTK_VERSION_0_43, ...
    + *
    + * This macro defines the earliest version of GPluginGtk that the package is
    + * required to be able to compile against.
    + *
    + * If the compiler is configured to warn about the use of deprecated functions,
    + * then using functions that were deprecated in version
    + * %GPLUGIN_GTK_VERSION_MIN_REQUIRED or earlier will cause warnings (but using
    + * functions deprecated in later releases will not).
    + *
    + * Since: 0.42
    + */
    +
    +/**
    * GPLUGIN_GTK_VERSION_CUR_STABLE:
    *
    * A macro that evaluates to the current stable version of GPlugin-Gtk, in a
    --- a/gplugin-gtk4/gplugin-gtk-view.c Wed Mar 20 22:34:37 2024 -0500
    +++ b/gplugin-gtk4/gplugin-gtk-view.c Wed Mar 20 23:10:34 2024 -0500
    @@ -467,7 +467,9 @@
    * gplugin_gtk_view_get_show_internal:
    * @view: The GTK view instance.
    *
    - * Returns whether or not @view is showing internal plugins.
    + * Gets whether or not @view is showing internal plugins.
    + *
    + * Returns: %TRUE if internal plugins are being shown, otherwise %FALSE.
    */
    gboolean
    gplugin_gtk_view_get_show_internal(GPluginGtkView *view)
    --- a/gplugin-gtk4/reference/gplugin-gtk4.toml.in Wed Mar 20 22:34:37 2024 -0500
    +++ b/gplugin-gtk4/reference/gplugin-gtk4.toml.in Wed Mar 20 23:10:34 2024 -0500
    @@ -46,3 +46,27 @@
    content_images = [
    ]
    urlmap_file = "urlmap.js"
    +
    +[[object]]
    +pattern = "DEPRECATED_IN_*"
    +hidden = true
    +
    +[[object]]
    +name = "DEPRECATED_FOR"
    +hidden = true
    +
    +[[object]]
    +name = "UNAVAILABLE"
    +hidden = true
    +
    +[[object]]
    +name = "UNAVAILABLE_MACRO"
    +hidden = true
    +
    +[[object]]
    +name = "UNAVAILABLE_STATIC_INLINE"
    +hidden = true
    +
    +[[object]]
    +name = "UNAVAILABLE_TYPE"
    +hidden = true
    --- a/gplugin-gtk4/reference/meson.build Wed Mar 20 22:34:37 2024 -0500
    +++ b/gplugin-gtk4/reference/meson.build Wed Mar 20 23:10:34 2024 -0500
    @@ -31,4 +31,15 @@
    install_dir : docs_dir,
    )
    +test('doc-check',
    + gidocgen,
    + args: [
    + 'check',
    + '--config', gplugin_gtk4_toml,
    + '--add-include-path=@0@'.format(meson.project_build_root() / 'gplugin'),
    + gplugin_gtk4_gir[0],
    + ],
    + depends: [gplugin_gir[0], gplugin_gtk4_gir[0]],
    +)
    +
    doc_targets += gplugin_gtk4_doc