[mutter] cogl/snippet: Use "Returns:" for introspection annotations



commit 86d3a6b4bc18cbf9cee75145290c3e0fe918774e
Author: Simon Schneegans <code simonschneegans de>
Date:   Wed May 18 23:02:48 2022 +0200

    cogl/snippet: Use "Returns:" for introspection annotations
    
    According to the GObject introspection documentation, "Returns:" should
    be used (rather than the previous "Return value:").
    
    Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/2422>

 cogl/cogl/cogl-snippet.h | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
---
diff --git a/cogl/cogl/cogl-snippet.h b/cogl/cogl/cogl-snippet.h
index 5965fc6297..5ef21b58a4 100644
--- a/cogl/cogl/cogl-snippet.h
+++ b/cogl/cogl/cogl-snippet.h
@@ -686,7 +686,7 @@ typedef enum
  *
  * Allocates and initializes a new snippet with the given source strings.
  *
- * Return value: (transfer full): a pointer to a new #CoglSnippet
+ * Returns: (transfer full): a pointer to a new #CoglSnippet
  *
  * Since: 1.10
  * Stability: Unstable
@@ -700,7 +700,7 @@ cogl_snippet_new (CoglSnippetHook hook,
  * cogl_snippet_get_hook:
  * @snippet: A #CoglSnippet
  *
- * Return value: (transfer none): the hook that was set when cogl_snippet_new()
+ * Returns: (transfer none): the hook that was set when cogl_snippet_new()
  *   was called.
  * Since: 1.10
  * Stability: Unstable
@@ -714,7 +714,7 @@ cogl_snippet_get_hook (CoglSnippet *snippet);
  *
  * Gets whether the given @object references an existing snippet object.
  *
- * Return value: %TRUE if the @object references a #CoglSnippet,
+ * Returns: %TRUE if the @object references a #CoglSnippet,
  *   %FALSE otherwise
  *
  * Since: 1.10
@@ -749,7 +749,7 @@ cogl_snippet_set_declarations (CoglSnippet *snippet,
  * cogl_snippet_get_declarations:
  * @snippet: A #CoglSnippet
  *
- * Return value: (transfer none): the source string that was set with
+ * Returns: (transfer none): the source string that was set with
  *   cogl_snippet_set_declarations() or %NULL if none was set.
  *
  * Since: 1.10
@@ -783,7 +783,7 @@ cogl_snippet_set_pre (CoglSnippet *snippet,
  * cogl_snippet_get_pre:
  * @snippet: A #CoglSnippet
  *
- * Return value: (transfer none): the source string that was set with
+ * Returns: (transfer none): the source string that was set with
  *   cogl_snippet_set_pre() or %NULL if none was set.
  *
  * Since: 1.10
@@ -817,7 +817,7 @@ cogl_snippet_set_replace (CoglSnippet *snippet,
  * cogl_snippet_get_replace:
  * @snippet: A #CoglSnippet
  *
- * Return value: (transfer none): the source string that was set with
+ * Returns: (transfer none): the source string that was set with
  *   cogl_snippet_set_replace() or %NULL if none was set.
  *
  * Since: 1.10
@@ -851,7 +851,7 @@ cogl_snippet_set_post (CoglSnippet *snippet,
  * cogl_snippet_get_post:
  * @snippet: A #CoglSnippet
  *
- * Return value: (transfer none): the source string that was set with
+ * Returns: (transfer none): the source string that was set with
  *   cogl_snippet_set_post() or %NULL if none was set.
  *
  * Since: 1.10


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