[goffice] Introspection fixes.



commit e5ef345c843265ff9eb88dc3d82dbe3878010588
Author: Morten Welinder <terra gnome org>
Date:   Thu Jun 11 17:14:04 2020 -0400

    Introspection fixes.

 NEWS                             |  1 +
 goffice/app/go-conf-keyfile.c    |  2 +-
 goffice/app/go-conf-win32.c      |  2 +-
 goffice/app/go-doc.c             |  2 +-
 goffice/app/go-plugin.c          |  4 ++--
 goffice/component/go-component.c |  2 +-
 goffice/data/go-data.c           |  2 +-
 goffice/graph/gog-axis.c         |  2 +-
 goffice/graph/gog-chart.c        |  2 +-
 goffice/graph/gog-data-set.c     |  2 +-
 goffice/graph/gog-object.c       |  6 +++---
 goffice/graph/gog-plot.c         |  2 +-
 goffice/graph/gog-view.c         |  8 ++++----
 goffice/gtk/go-combo-color.c     |  2 +-
 goffice/gtk/go-palette.c         |  4 ++--
 goffice/gtk/goffice-gtk.c        | 10 +++++-----
 goffice/math/go-cspline.c        |  6 +++---
 goffice/utils/go-format.c        |  4 ++--
 goffice/utils/go-glib-extras.c   |  2 +-
 goffice/utils/go-string.c        |  4 ++--
 20 files changed, 35 insertions(+), 34 deletions(-)
---
diff --git a/NEWS b/NEWS
index 5ec83e17..864cc98d 100644
--- a/NEWS
+++ b/NEWS
@@ -9,6 +9,7 @@ Jean:
 
 Morten:
        * Avoid critical in document image handling.
+       * Introspection fixes.
 
 --------------------------------------------------------------------------
 goffice 0.10.47:
diff --git a/goffice/app/go-conf-keyfile.c b/goffice/app/go-conf-keyfile.c
index 2447782b..c41c8e65 100644
--- a/goffice/app/go-conf-keyfile.c
+++ b/goffice/app/go-conf-keyfile.c
@@ -283,7 +283,7 @@ go_conf_get_double (GOConfNode *node, gchar const *key)
 /**
  * go_conf_get_string :
  * @node: #GOConfNode
- * @key: non NULL string.
+ * @key: non-%NULL string.
  *
  * Returns: the string value of @node's @key child as a string which the called needs to free
  **/
diff --git a/goffice/app/go-conf-win32.c b/goffice/app/go-conf-win32.c
index 9311cd34..b7a3c381 100644
--- a/goffice/app/go-conf-win32.c
+++ b/goffice/app/go-conf-win32.c
@@ -395,7 +395,7 @@ go_conf_get_double (GOConfNode *node, gchar const *key)
 /**
  * go_conf_get_string :
  * @node: #GOConfNode
- * @key: non NULL string.
+ * @key: non-%NULL string.
  *
  * Returns: the string value of @node's @key child as a string which the called needs to free
  **/
diff --git a/goffice/app/go-doc.c b/goffice/app/go-doc.c
index 6e7c8ffc..7b1776c5 100644
--- a/goffice/app/go-doc.c
+++ b/goffice/app/go-doc.c
@@ -474,7 +474,7 @@ go_doc_get_image (GODoc *doc, char const *id)
 /**
  * go_doc_add_image:
  * @doc: a #GODoc
- * @id: the image name or NULL
+ * @id: the image name or %NULL
  * @image: a #GOImage
  *
  * Adds @image to the document if no such image already exists. The name of
diff --git a/goffice/app/go-plugin.c b/goffice/app/go-plugin.c
index df3e054e..483349e7 100644
--- a/goffice/app/go-plugin.c
+++ b/goffice/app/go-plugin.c
@@ -531,7 +531,7 @@ go_plugin_get_name (GOPlugin *plugin)
  * go_plugin_get_description:
  * @plugin: #GOPlugin
  *
- * Returns: textual description of @plugin or NULL if description is not
+ * Returns: textual description of @plugin or %NULL if description is not
  *     available.  Returned string stays valid during @plugin's lifetime.
  **/
 gchar const *
@@ -1600,7 +1600,7 @@ go_plugins_get_active_plugins (void)
  * go_plugins_get_plugin_by_id:
  * @plugin_id: String containing plugin ID
  *
- * Returns: (transfer none): GOPlugin object for plugin with ID equal to @plugin_id or NULL
+ * Returns: (transfer none): GOPlugin object for plugin with ID equal to @plugin_id or %NULL
  *     if there's no plugin available with given id.  Function returns
  *     "borrowed" reference, use g_object_ref if you want to be sure that
  *     plugin won't disappear.
diff --git a/goffice/component/go-component.c b/goffice/component/go-component.c
index c4c54bef..9e2c5e9c 100644
--- a/goffice/component/go-component.c
+++ b/goffice/component/go-component.c
@@ -506,7 +506,7 @@ editor_destroy_cb (GOComponent *component)
  * @component: #GOComponent
  *
  * Opens a top level window editor for the component if it can be edited.
- * Returns: (transfer none): the editor window or NULL
+ * Returns: (transfer none): the editor window or %NULL
  */
 GtkWindow *
 go_component_edit (GOComponent *component)
diff --git a/goffice/data/go-data.c b/goffice/data/go-data.c
index cb776028..a900358b 100644
--- a/goffice/data/go-data.c
+++ b/goffice/data/go-data.c
@@ -221,7 +221,7 @@ go_data_preferred_fmt (GOData const *dat)
  * go_data_date_conv :
  * @dat: #GOData
  *
- * Returns: the date conventions used by the data, or NULL if not determined.
+ * Returns: the date conventions used by the data, or %NULL if not determined.
  **/
 GODateConventions const *
 go_data_date_conv (GOData const *dat)
diff --git a/goffice/graph/gog-axis.c b/goffice/graph/gog-axis.c
index 35f71339..32023db3 100644
--- a/goffice/graph/gog-axis.c
+++ b/goffice/graph/gog-axis.c
@@ -2531,7 +2531,7 @@ gog_axis_finalize (GObject *obj)
  * gog_axis_get_entry:
  * @axis: #GogAxis
  * @i:
- * @user_defined: an optionally NULL pointr to gboolean
+ * @user_defined: an optionally %NULL pointr to gboolean
  *
  * Returns: the value of axis element @i and sets @user_defined or
  *     NaN on error
diff --git a/goffice/graph/gog-chart.c b/goffice/graph/gog-chart.c
index 4a15553f..502cc69a 100644
--- a/goffice/graph/gog-chart.c
+++ b/goffice/graph/gog-chart.c
@@ -917,7 +917,7 @@ gog_chart_set_plot_area (GogChart *chart, GogViewAllocation const *plot_area)
  * chart elements that require a different style. Visible cardinality is
  * the number of chart elements shown in chart legend.
  *
- * @full and @visible may be NULL.
+ * @full and @visible may be %NULL.
  **/
 void
 gog_chart_get_cardinality (GogChart *chart, unsigned *full, unsigned *visible)
diff --git a/goffice/graph/gog-data-set.c b/goffice/graph/gog-data-set.c
index c0b18fc2..94545e99 100644
--- a/goffice/graph/gog-data-set.c
+++ b/goffice/graph/gog-data-set.c
@@ -105,7 +105,7 @@ gog_dataset_get_dim (GogDataset const *set, int dim_i)
  * @val: (transfer full): #GOData
  * @err: #GError
  *
- * Absorbs a ref to @val if it is non NULL
+ * Absorbs a ref to @val if it is non-%NULL
  **/
 void
 gog_dataset_set_dim (GogDataset *set, int dim_i, GOData *val, GError **err)
diff --git a/goffice/graph/gog-object.c b/goffice/graph/gog-object.c
index f8e8939f..8a820467 100644
--- a/goffice/graph/gog-object.c
+++ b/goffice/graph/gog-object.c
@@ -1093,8 +1093,8 @@ dataset_dup (GogDataset const *src, GogDataset *dst)
 /**
  * gog_object_dup:
  * @src: #GogObject
- * @new_parent: #GogObject the parent tree for the object (can be NULL)
- * @datadup: (scope call): a function to duplicate the data (a default one is used if NULL)
+ * @new_parent: #GogObject the parent tree for the object (can be %NULL)
+ * @datadup: (scope call): a function to duplicate the data (a default one is used if %NULL)
  *
  * Create a deep copy of @obj using @new_parent as its parent.
  *
@@ -1522,7 +1522,7 @@ gog_object_reorder (GogObject const *obj, gboolean inc, gboolean goto_max)
        } else
                obj_follows = NULL;
 
-       /* Pass the sibling that precedes obj, or NULL if is the head */
+       /* Pass the sibling that precedes obj, or %NULL if is the head */
        g_signal_emit (G_OBJECT (parent),
                gog_object_signals [CHILDREN_REORDERED], 0);
        gog_object_emit_changed (parent, FALSE);
diff --git a/goffice/graph/gog-plot.c b/goffice/graph/gog-plot.c
index 5d485baa..219441a0 100644
--- a/goffice/graph/gog-plot.c
+++ b/goffice/graph/gog-plot.c
@@ -678,7 +678,7 @@ gog_plot_update_cardinality (GogPlot *plot, int index_num)
  * Return the number of logical elements in the plot.
  * See @gog_chart_get_cardinality.
  *
- * @full and @visible may be NULL.
+ * @full and @visible may be %NULL.
  **/
 void
 gog_plot_get_cardinality (GogPlot *plot, unsigned *full, unsigned *visible)
diff --git a/goffice/graph/gog-view.c b/goffice/graph/gog-view.c
index bae878bf..a5886ab2 100644
--- a/goffice/graph/gog-view.c
+++ b/goffice/graph/gog-view.c
@@ -1052,7 +1052,7 @@ gog_view_get_toolkit (GogView *view)
  * @view: #GogView
  * @x: in coords
  * @y: in coords
- * @gobj: pointed object or NULL
+ * @gobj: pointed object or %NULL
  *
  * Returns: (transfer none): tool under cursor for a given view, or %NULL
  **/
@@ -1083,8 +1083,8 @@ gog_view_get_tool_at_point (GogView *view, double x, double y, GogObject **gobj)
  * @view: #GogView
  * @x: cursor x position
  * @y: cursor y position
- * @obj: pointed object or NULL
- * @tool: pointed tool or NULL
+ * @obj: pointed object or %NULL
+ * @tool: pointed tool or %NULL
  *
  * Gets view under cursor, searching recursively from @view. Corresponding object
  * is stored in @obj. This object may or may not be @view->model of pointed view.
@@ -1133,7 +1133,7 @@ gog_view_get_view_at_point (GogView *view, double x, double y, GogObject **obj,
  * Gets a tip string related to the position as defined by (@x,@y) in @view.
  *
  * return value: the newly allocated tip string if the view class supports
- * that or NULL.
+ * that or %NULL.
  **/
 char*
 gog_view_get_tip_at_point (GogView *view, double x, double y)
diff --git a/goffice/gtk/go-combo-color.c b/goffice/gtk/go-combo-color.c
index 6d98d5d3..7b0a8610 100644
--- a/goffice/gtk/go-combo-color.c
+++ b/goffice/gtk/go-combo-color.c
@@ -359,7 +359,7 @@ go_combo_color_set_icon (GOComboColor *cc, GdkPixbuf *icon)
 
 /**
  * go_combo_color_new :
- * @icon: optionally NULL.
+ * @icon: optionally %NULL.
  * @no_color_label: FIXME
  * @default_color: The colour to use as the default
  * @color_group: #GOColorGroup
diff --git a/goffice/gtk/go-palette.c b/goffice/gtk/go-palette.c
index 966a93aa..c7bf10b2 100644
--- a/goffice/gtk/go-palette.c
+++ b/goffice/gtk/go-palette.c
@@ -330,7 +330,7 @@ go_palette_new (int n_swatches,
  * go_palette_show_automatic:
  * @palette: a #GOPalette
  * @index: index to use on automatic item activation
- * @label: if not NULL, replace automatic button label
+ * @label: if not %NULL, replace automatic button label
  *
  * Adds an automatic button to @palette.
  **/
@@ -354,7 +354,7 @@ go_palette_show_automatic (GOPalette *palette,
 /**
  * go_palette_show_custom:
  * @palette: a #GOPalette
- * @label: if not NULL, replaces custom button label
+ * @label: if not %NULL, replaces custom button label
  *
  * Adds a custom button to bottom of @palette. An activation
  * of custom button will cause an emition of "custom_activate" signal.
diff --git a/goffice/gtk/goffice-gtk.c b/goffice/gtk/goffice-gtk.c
index 37b7a7ee..9fd6c59e 100644
--- a/goffice/gtk/goffice-gtk.c
+++ b/goffice/gtk/goffice-gtk.c
@@ -166,7 +166,7 @@ apply_ui_from_file (GtkBuilder *gui, GsfInput *src, const char *uifile,
  * Simple utility to open ui files
  *
  * Since 0.9.6
- * Returns: (transfer full): a new #GtkBuilder or NULL
+ * Returns: (transfer full): a new #GtkBuilder or %NULL
  *
  * @uifile should be one of these:
  *
@@ -268,7 +268,7 @@ go_gtk_builder_load (char const *uifile,
  * Simple utility to open ui files
  *
  * Deprecated: 0.9.6, use go_gtk_builder_load().
- * Returns: (transfer full): a new #GtkBuilder or NULL
+ * Returns: (transfer full): a new #GtkBuilder or %NULL
  *
  * @uifile should be one of these:
  *
@@ -294,7 +294,7 @@ go_gtk_builder_new (char const *uifile,
  * Simple utility to open ui files
  *
  * Since: 0.9.6
- * Returns: (transfer full): a new #GtkBuilder or NULL
+ * Returns: (transfer full): a new #GtkBuilder or %NULL
  *
  * Variant of go_gtk_builder_new that searchs goffice directories
  * for files.
@@ -385,7 +385,7 @@ go_gtk_builder_signal_connect_swapped (GtkBuilder   *gui,
  * Simple wrapper to #gtk_builder_get_object which returns the object
  * as a GtkWidget.
  *
- * Returns: (transfer none): a new #GtkWidget or NULL
+ * Returns: (transfer none): a new #GtkWidget or %NULL
  **/
 GtkWidget *
 go_gtk_builder_get_widget (GtkBuilder *gui, char const *widget_name)
@@ -401,7 +401,7 @@ go_gtk_builder_get_widget (GtkBuilder *gui, char const *widget_name)
  * searches the #GtkComboBox in @gui and ensures it has a model and a
  * renderer appropriate for using with #gtk_combo_box_append_text and friends.
  *
- * Returns: (transfer none): the #GtkComboBox or NULL
+ * Returns: (transfer none): the #GtkComboBox or %NULL
  **/
 GtkComboBox *
 go_gtk_builder_combo_box_init_text (GtkBuilder *gui, char const *widget_name)
diff --git a/goffice/math/go-cspline.c b/goffice/math/go-cspline.c
index f37bf818..98bf2698 100644
--- a/goffice/math/go-cspline.c
+++ b/goffice/math/go-cspline.c
@@ -341,7 +341,7 @@ DOUBLE SUFFIX(go_cspline_get_deriv) (SUFFIX(GOCSpline) const *sp, DOUBLE x)
  * The x values must be sorted in increasing order.
  *
  * Returns: a newly allocated array of interpolated values which should
- * be destroyed by a call to g_free when not anymore needed, or NULL if
+ * be destroyed by a call to g_free when not anymore needed, or %NULL if
  * an error occurred.
  */
 DOUBLE *SUFFIX(go_cspline_get_values) (SUFFIX(GOCSpline) const *sp, DOUBLE const *x, int n)
@@ -375,7 +375,7 @@ DOUBLE *SUFFIX(go_cspline_get_values) (SUFFIX(GOCSpline) const *sp, DOUBLE const
  * The x values must be sorted in increasing order.
  *
  * Returns: a newly allocated array of the n interpolated derivatives which
- * should be destroyed by a call to g_free when not anymore needed, or NULL if
+ * should be destroyed by a call to g_free when not anymore needed, or %NULL if
  * an error occurred.
  */
 DOUBLE *SUFFIX(go_cspline_get_derivs) (SUFFIX(GOCSpline) const *sp, DOUBLE const *x, int n)
@@ -410,7 +410,7 @@ DOUBLE *SUFFIX(go_cspline_get_derivs) (SUFFIX(GOCSpline) const *sp, DOUBLE const
  *
  * Returns: a newly allocated array of the n-1 integrals on the intervals
  * between two consecutive values stored in x. which should be destroyed by
- * a call to g_free when not anymore needed, or NULL if  an error occurred.
+ * a call to g_free when not anymore needed, or %NULL if  an error occurred.
  */
 DOUBLE *SUFFIX(go_cspline_get_integrals) (SUFFIX(GOCSpline) const *sp, DOUBLE const *x, int n)
 {
diff --git a/goffice/utils/go-format.c b/goffice/utils/go-format.c
index 5935ed34..93e9f766 100644
--- a/goffice/utils/go-format.c
+++ b/goffice/utils/go-format.c
@@ -5469,7 +5469,7 @@ _go_number_format_shutdown (void)
  * Localizes the given format string, i.e., changes decimal dots to the
  * locale's notion of that and performs other such transformations.
  *
- * Returns: a localized format string, or NULL if the format was not valid.
+ * Returns: a localized format string, or %NULL if the format was not valid.
  **/
 char *
 go_format_str_localize (char const *str)
@@ -5585,7 +5585,7 @@ go_format_str_localize (char const *str)
  * De-localizes the given format string, i.e., changes locale's decimal
  * separators to dots and performs other such transformations.
  *
- * Returns: a non-local format string, or NULL if the format was not valid.
+ * Returns: a non-local format string, or %NULL if the format was not valid.
  **/
 char *
 go_format_str_delocalize (char const *str)
diff --git a/goffice/utils/go-glib-extras.c b/goffice/utils/go-glib-extras.c
index 779fe400..68bc5488 100644
--- a/goffice/utils/go-glib-extras.c
+++ b/goffice/utils/go-glib-extras.c
@@ -246,7 +246,7 @@ go_strescape (GString *target, char const *string)
 
 /*
  * The reverse operation of go_strescape.  Returns a pointer to the
- * first char after the string on success or NULL on failure.
+ * first char after the string on success or %NULL on failure.
  *
  * First character of the string should be an ASCII character used
  * for quoting.
diff --git a/goffice/utils/go-string.c b/goffice/utils/go-string.c
index 496a8d2d..54011f86 100644
--- a/goffice/utils/go-string.c
+++ b/goffice/utils/go-string.c
@@ -117,7 +117,7 @@ replace_rich_base_with_plain (GOStringRichImpl *rich)
  *
  * GOString duplicates @str if no string already exists.
  *
- * Returns: a reference to a #GOString containing @str, or %NULL if @str is NULL
+ * Returns: a reference to a #GOString containing @str, or %NULL if @str is %NULL
  **/
 GOString *
 go_string_new_len (char const *str, guint32 len)
@@ -185,7 +185,7 @@ go_string_new_nocopy_len (char *str, guint32 len)
  *
  * GOString duplicates @str if no string already exists.
  *
- * Returns: a reference to a #GOString containing @str, or %NULL if @str is NULL
+ * Returns: a reference to a #GOString containing @str, or %NULL if @str is %NULL
  **/
 GOString *
 go_string_new (char const *str)


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]