[glibmm] Variant: Slightly elaborate Variant<Variant> docs



commit bbd16d312ffb28136ae0eb9231c17450def83cd5
Author: Daniel Boles <dboles src gnome org>
Date:   Mon Jan 15 15:33:40 2018 +0000

    Variant: Slightly elaborate Variant<Variant> docs
    
    Point out get_n_children() for checking nullable status, and copy the
    doc for Variant<VariantBase> to Variant< Variant<T> >.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=778219

 glib/src/variant.hg |    9 ++++++++-
 1 files changed, 8 insertions(+), 1 deletions(-)
---
diff --git a/glib/src/variant.hg b/glib/src/variant.hg
index 60ab678..95633c7 100644
--- a/glib/src/variant.hg
+++ b/glib/src/variant.hg
@@ -437,7 +437,9 @@ public:
 
 /** Specialization of Variant containing a VariantBase.
  * Perhaps the main use of this is as a maybe-typed (i.e. nullable) Variant, as
- * it inherits methods create_maybe() and get_maybe() from VariantContainerBase.
+ * it inherits the methods create_maybe() and get_maybe() from
+ * VariantContainerBase, plus get_n_children() to allow checking whether there
+ * is a contained value, i.e. the inner Variant is not <tt>nothing</tt>.
  *
  * @newin{2,28}
  * @ingroup Variant
@@ -488,6 +490,11 @@ public:
 };
 
 /** Specialization of Variant containing a Variant<T>.
+ * Perhaps the main use of this is as a maybe-typed (i.e. nullable) Variant, as
+ * it inherits the methods create_maybe() and get_maybe() from
+ * VariantContainerBase, plus get_n_children() to allow checking whether there
+ * is a contained value, i.e. the inner Variant is not <tt>nothing</tt>.
+ *
  * @newin{2,36}
  * @ingroup Variant
  */


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