gplugin/gplugin

Fix plugin row docs

19 months ago, Elliott Sales de Andrade
acb56ed64e56
Parents 5dfb747dafa8
Children 2ab8afb6e8be
Fix plugin row docs

Add a missing property doc and `Since` tags.

Testing Done:
Compiled and skimmed through the docs.

Reviewed at https://reviews.imfreedom.org/r/1841/
1 files changed, 26 insertions(+), 3 deletions(-)
  • +26 -3
    gplugin-gtk4/gplugin-gtk-plugin-row.c
    • --- a/gplugin-gtk4/gplugin-gtk-plugin-row.c Sun Sep 25 00:45:47 2022 -0500
    +++ b/gplugin-gtk4/gplugin-gtk-plugin-row.c Sun Sep 25 23:58:35 2022 -0500
    @@ -384,6 +384,14 @@
    obj_class->finalize = gplugin_gtk_plugin_row_finalize;
    /* properties */
    +
    + /**
    + * GPluginGtkPluginRow:plugin:
    + *
    + * The [iface@GPlugin.Plugin] whose info should be displayed.
    + *
    + * Since: 0.38.0
    + */
    properties[PROP_PLUGIN] = g_param_spec_object(
    "plugin",
    "plugin",
    @@ -509,10 +517,12 @@
    /**
    * gplugin_gtk_plugin_row_new:
    *
    - * Create a new [class@GPluginGtk4.View] which can be used to display info
    + * Create a new [class@GPluginGtk4.PluginRow] which can be used to display info
    * about a [iface@GPlugin.Plugin].
    *
    * Returns: (transfer full): The new widget.
    + *
    + * Since: 0.38.0
    */
    GtkWidget *
    gplugin_gtk_plugin_row_new(void)
    @@ -523,11 +533,13 @@
    /**
    * gplugin_gtk_plugin_row_set_plugin:
    * @row: The plugin row instance.
    - * @plugin: The plugin instance.
    + * @plugin: (nullable): The plugin instance.
    *
    * Sets the [iface@GPlugin.Plugin] that should be displayed.
    *
    * A @plugin value of %NULL will clear the widget.
    + *
    + * Since: 0.38.0
    */
    void
    gplugin_gtk_plugin_row_set_plugin(
    @@ -549,7 +561,10 @@
    *
    * Returns the [iface@GPlugin.Plugin] that's being displayed.
    *
    - * Returns: (transfer none): The plugin that's being displayed.
    + * Returns: (transfer none) (nullable): The plugin that's being displayed, or
    + * %NULL if the row is empty.
    + *
    + * Since: 0.38.0
    */
    GPluginPlugin *
    gplugin_gtk_plugin_row_get_plugin(GPluginGtkPluginRow *row)
    @@ -566,6 +581,8 @@
    * Returns whether the plugin row is showing detailed information.
    *
    * Returns: %TRUE if the plugin row is expanded, %FALSE otherwise.
    + *
    + * Since: 0.38.0
    */
    gboolean
    gplugin_gtk_plugin_row_get_expanded(GPluginGtkPluginRow *row)
    @@ -581,6 +598,8 @@
    * @expanded: Whether the plugin row is expanded.
    *
    * Sets whether the plugin row is showing detailed information.
    + *
    + * Since: 0.38.0
    */
    void
    gplugin_gtk_plugin_row_set_expanded(GPluginGtkPluginRow *row, gboolean expanded)
    @@ -598,6 +617,8 @@
    * Returns a key that can be used to sort this row.
    *
    * Returns: The sort key.
    + *
    + * Since: 0.38.0
    */
    gchar *
    gplugin_gtk_plugin_row_get_sort_key(GPluginGtkPluginRow *row)
    @@ -615,6 +636,8 @@
    * Matches this row instance against some text to be searched for.
    *
    * Returns: Whether the row matches the text or not.
    + *
    + * Since: 0.38.0
    */
    gboolean
    gplugin_gtk_plugin_row_matches_search(