Glib::Variant—Improve documentation of get_maybe()

Clarify what is set and returned, and use lower case “nothing” to match
how that must be written in GVariant text format, à la GSettings, etc.

https://bugzilla.gnome.org/show_bug.cgi?id=778219

1 files changed, 5 insertions, 4 deletions

diff --git a/glib/src/variant.hg b/glib/src/variant.hg
index be0f4a78..5de30dc4 100644
--- a/glib/src/variant.hg
+++ b/glib/src/variant.hg
@@ -411,11 +411,12 @@ public:
   DataType get_child(gsize index = 0) const;
   */
 
-  /** If this is a maybe-typed instance, extract its value. If the value is
-   * Nothing, then this function returns <tt>false</tt>.
+  /** If this is a maybe-typed instance, try to extract its value. If there is
+   * no value (the value is <tt>nothing</tt>), return <tt>false</tt. Otherwise,
+   * the value is copied to the supplied Variant and <tt>true</tt> is returned.
    *
-   * @param maybe A place in which to return the value (the value may be
-   * <tt>0</tt>).
+   * @param maybe A place in which to return the value, if it isn’t
+   * <tt>nothing</tt>.
    * @newin{2,28}
    */
   bool get_maybe(VariantBase& maybe) const;