[perl-Glib] Docs: add missing blurbs for the benefit of 'whatis'



commit 0a2770e9dba51246f22a59a98de465e02a8901ad
Author: intrigeri <intrigeri boum org>
Date:   Tue Aug 18 08:15:00 2015 +0000

    Docs: add missing blurbs for the benefit of 'whatis'
    
    https://bugzilla.gnome.org/show_bug.cgi?id=753466

 GOption.xs    |    8 ++++++++
 GParamSpec.xs |   27 +++++++++++++++++++++++----
 GType.xs      |    2 ++
 GUtils.xs     |    3 +++
 4 files changed, 36 insertions(+), 4 deletions(-)
---
diff --git a/GOption.xs b/GOption.xs
index cae3b6b..4c19e62 100644
--- a/GOption.xs
+++ b/GOption.xs
@@ -610,6 +610,14 @@ BOOT:
        gperl_register_fundamental (GPERL_TYPE_OPTION_ARG, "Glib::OptionArg");
        gperl_register_fundamental (GPERL_TYPE_OPTION_FLAGS, "Glib::OptionFlags");
 
+=for object Glib::OptionContext defines options accepted by the commandline option parser
+
+=cut
+
+=for object Glib::OptionGroup group of options for command line option parsing
+
+=cut
+
 =for position SYNOPSIS
 
 =head1 SYNOPSIS
diff --git a/GParamSpec.xs b/GParamSpec.xs
index 909deb5..99911e4 100644
--- a/GParamSpec.xs
+++ b/GParamSpec.xs
@@ -185,6 +185,8 @@ SvGParamSpec (SV * sv)
 
 MODULE = Glib::ParamSpec       PACKAGE = Glib::ParamSpec       PREFIX = g_param_spec_
 
+=for object Glib::ParamSpec encapsulates metadate needed to specify parameters
+
 void
 DESTROY (GParamSpec * pspec)
     CODE:
@@ -891,7 +893,7 @@ MODULE = Glib::ParamSpec    PACKAGE = Glib::Param::UChar
  ## similarly, all unsigned integer types
 
 
-=for object Glib::Param::UInt
+=for object Glib::Param::UInt Wrapper for uint parameters in GLib
 
 =for position post_hierarchy
 
@@ -962,7 +964,7 @@ get_maximum (GParamSpec * pspec)
 
 MODULE = Glib::ParamSpec       PACKAGE = Glib::Param::Int64
 
-=for object Glib::Param::Int64
+=for object Glib::Param::Int64 Wrapper for int64 parameters in GLib
 
 =head1 DESCRIPTION
 
@@ -989,7 +991,7 @@ get_maximum (GParamSpec * pspec)
 
 MODULE = Glib::ParamSpec       PACKAGE = Glib::Param::UInt64
 
-=for object Glib::Param::UInt64
+=for object Glib::Param::UInt64 Wrapper for uint64 parameters in GLib
 
 =head1 DESCRIPTION
 
@@ -1018,7 +1020,7 @@ MODULE = Glib::ParamSpec  PACKAGE = Glib::Param::Float
 
  ## and again for the floating-point types
 
-=for object Glib::Param::Double
+=for object Glib::Param::Double Wrapper for double parameters in GLib
 
 =for position post_hierarchy
 
@@ -1037,6 +1039,21 @@ determines the data value range.
 
 =cut
 
+=for object Glib::Param::Boolean Wrapper for boolean parameters in GLib
+=cut
+
+=for object Glib::Param::Enum Wrapper for enum parameters in GLib
+=cut
+
+=for object Glib::Param::Flags Wrapper for flag parameters in GLib
+=cut
+
+=for object Glib::Param::String Wrapper for string parameters in GLib
+=cut
+
+=for object Glib::Param::Unichar Wrapper for unichar parameters in GLib
+=cut
+
 =for see_also Glib::ParamSpec
 =cut
 
@@ -1122,6 +1139,8 @@ MODULE = Glib::ParamSpec  PACKAGE = Glib::Param::GType
 
 #if GLIB_CHECK_VERSION(2, 10, 0)
 
+=for object Glib::Param::GType - Wrapper for type parameters in GLib
+
 =for section DESCRIPTION
 
 =head1 DESCRIPTION
diff --git a/GType.xs b/GType.xs
index 142eb55..614d4af 100644
--- a/GType.xs
+++ b/GType.xs
@@ -2746,6 +2746,8 @@ package_from_cname (class, const char * cname)
 
 MODULE = Glib::Type    PACKAGE = Glib::Flags
 
+=for object Glib::Flags methods and overloaded operators for flags
+
 =for position DESCRIPTION
 
 =head1 DESCRIPTION
diff --git a/GUtils.xs b/GUtils.xs
index c59f704..4403a01 100644
--- a/GUtils.xs
+++ b/GUtils.xs
@@ -469,6 +469,9 @@ CHECK_VERSION (class, guint required_major, guint required_minor, guint required
 
 MODULE = Glib::Utils   PACKAGE = Glib::Markup  PREFIX = g_markup_
 
+=for object Glib::Markup markup handling functions
+=cut
+
 =for apidoc __function__
 =cut
 # gchar* g_markup_escape_text (const gchar *text, gssize length);


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