Re: gtk adjust docs on emit



Kevin Ryde wrote:
I thought a remark like below might be good for the GtkAdjustment field
accessors, though I couldn't tell how to get it coming out right with
the xsdoc stuff ...

Looks good.  To achieve what I think you wanted, we need to tell the doc
parser to not generate POD for the accessors.  Committed as attached.
Thanks!

-- 
Bye,
-Torsten
Index: xs/GtkAdjustment.xs
===================================================================
RCS file: /cvsroot/gtk2-perl/gtk2-perl-xs/Gtk2/xs/GtkAdjustment.xs,v
retrieving revision 1.9
diff -u -d -p -r1.9 GtkAdjustment.xs
--- xs/GtkAdjustment.xs 26 Feb 2004 00:57:54 -0000      1.9
+++ xs/GtkAdjustment.xs 1 Jun 2008 12:15:06 -0000
@@ -23,6 +23,47 @@
 
 MODULE = Gtk2::Adjustment      PACKAGE = Gtk2::Adjustment      PREFIX = gtk_adjustment_
 
+=for apidoc Gtk2::Adjustment::value
+=for signature double = $adjustment->value
+=for signature double = $adjustment->value ($newval)
+=for signature double = $adjustment->lower
+=for signature double = $adjustment->lower ($newval)
+=for signature double = $adjustment->upper
+=for signature double = $adjustment->upper ($newval)
+=for signature double = $adjustment->step_increment
+=for signature double = $adjustment->step_increment ($newval)
+=for signature double = $adjustment->page_increment
+=for signature double = $adjustment->page_increment ($newval)
+=for signature double = $adjustment->page_size
+=for signature double = $adjustment->page_size ($newval)
+
+Get or set the six fields of a Gtk2::Adjustment.
+
+The setter functions store $newval and return the old value.  Note
+that they don't emit any signals; it's up to you to emit "notify"
+(because the fields are also properties) and "changed" or
+"value-changed", when you're ready.
+
+=cut
+
+=for apidoc value __hide__
+=cut
+
+=for apidoc lower __hide__
+=cut
+
+=for apidoc upper __hide__
+=cut
+
+=for apidoc step_increment __hide__
+=cut
+
+=for apidoc page_increment __hide__
+=cut
+
+=for apidoc page_size __hide__
+=cut
+
 gdouble
 value (GtkAdjustment *adjustment, gdouble newval = 0)
     ALIAS:


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