[goffice] Introspection and docs fixes.
- From: Morten Welinder <mortenw src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [goffice] Introspection and docs fixes.
- Date: Sun, 20 Feb 2022 16:55:22 +0000 (UTC)
commit 7e745432c78373d1633845e12c9d915ab7414de2
Author: Morten Welinder <terra gnome org>
Date: Sun Feb 20 11:55:07 2022 -0500
Introspection and docs fixes.
goffice/canvas/goc-item.c | 1 +
goffice/canvas/goc-utils.c | 21 ++++++++++-----------
goffice/math/go-math.c | 4 ++--
goffice/utils/go-pattern.c | 3 +--
4 files changed, 14 insertions(+), 15 deletions(-)
---
diff --git a/goffice/canvas/goc-item.c b/goffice/canvas/goc-item.c
index 33b02896..936e42d5 100644
--- a/goffice/canvas/goc-item.c
+++ b/goffice/canvas/goc-item.c
@@ -116,6 +116,7 @@ enum {
* reposition children of the GtkLayout parent of the canvas to their new
* position.
* @get_window: returns the #GdkWindow for the item if any.
+ * @copy: method for copying an item.
*
* The base class for all canvas items.
**/
diff --git a/goffice/canvas/goc-utils.c b/goffice/canvas/goc-utils.c
index 8c1e9a51..305039da 100644
--- a/goffice/canvas/goc-utils.c
+++ b/goffice/canvas/goc-utils.c
@@ -48,7 +48,7 @@
* points->points[0].y = my_y;
* </programlisting>
*
- * Returns: the newly created #GocPoints with an initial references count of 1.
+ * Returns: the newly created #GocPoints with an initial reference count of 1.
**/
GocPoints *
@@ -65,7 +65,7 @@ goc_points_new (unsigned n)
* goc_points_ref :
* @points: #GocPoints
*
- * Increases the references count of @points by 1.
+ * Increases the reference count of @points by 1.
* Returns: the referenced #GocPoints.
**/
GocPoints *
@@ -79,8 +79,8 @@ goc_points_ref (GocPoints *points)
* goc_points_unref:
* @points: #GocPoints
*
- * Decreases the references count of @points by 1, and destroys it if the
- * references count becomes 0.
+ * Decreases the reference count of @points by 1, and destroys it if the
+ * reference count becomes 0.
**/
void
goc_points_unref (GocPoints *points)
@@ -111,8 +111,7 @@ goc_points_get_type (void)
/**
* GocIntArray:
* @vals: The embedded values.
- *
- * FocIntArray::n is the size of the array.
+ * @n: the size of the array.
* A boxed type used to hold an array of integers.
* Since: 0.8.2
**/
@@ -125,12 +124,12 @@ goc_points_get_type (void)
* The values can be changed using direct access:
*
* <programlisting>
- * GocIntArray array = goc_int_array_new (2);
+ * GocIntArray *array = goc_int_array_new (2);
* array->vals[0] = my_first_int;
* array->vals[1] = my_second_int;
* </programlisting>
*
- * Returns: the newly created #GocIntArray with an initial references count of 1.
+ * Returns: the newly created #GocIntArray with an initial reference count of 1.
* Since: 0.8.2
**/
@@ -148,7 +147,7 @@ goc_int_array_new (unsigned n)
* goc_int_array_ref :
* @array: #GocIntArray
*
- * Increases the references count of @array by 1.
+ * Increases the reference count of @array by 1.
* Returns: the referenced #GocIntArray.
* Since: 0.8.2
**/
@@ -163,8 +162,8 @@ goc_int_array_ref (GocIntArray *array)
* goc_int_array_unref:
* @array: #GocIntArray
*
- * Decreases the references count of @array by 1, and destroys it if the
- * references count becomes 0.
+ * Decreases the reference count of @array by 1, and destroys it if the
+ * reference count becomes 0.
* Since: 0.8.2
**/
void
diff --git a/goffice/math/go-math.c b/goffice/math/go-math.c
index ccd8e5af..4349945d 100644
--- a/goffice/math/go-math.c
+++ b/goffice/math/go-math.c
@@ -426,7 +426,7 @@ strtod_helper (const char *s)
/*
* go_strtod: A sane strtod.
* @s: string to convert
- * @end: (out): optional pointer to end of string.
+ * @end: (out) (transfer none) (optional): pointer to end of string.
*
* Returns: the numeric value of the given string.
* Like strtod, but without hex notation and MS extensions.
@@ -670,7 +670,7 @@ go_log10l (long double x)
/*
* go_strtold: A sane strtold.
* @s: string to convert
- * @end: (out): optional pointer to end of string.
+ * @end: (out) (transfer none) (optional): pointer to end of string.
*
* Returns: the numeric value of the given string.
* Like strtold, but without hex notation and MS extensions.
diff --git a/goffice/utils/go-pattern.c b/goffice/utils/go-pattern.c
index 2d676384..a447046d 100644
--- a/goffice/utils/go-pattern.c
+++ b/goffice/utils/go-pattern.c
@@ -65,8 +65,7 @@
* GOPattern:
* @fore: foreground color.
* @back: background color.
- *
- * GOPattern::pattern is the used #GOPatternType.
+ * @pattern: A #GOPatternType specifying what kinf of pattern to use.
**/
typedef struct {
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]