pygobject / pgi-docgen

API Documentation Generator for PyGObject
https://lazka.github.io/pgi-docs/
GNU Lesser General Public License v2.1
127 stars 36 forks source link

Parameter documented as int instead of Gtk.IconSize #104

Closed aleb closed 8 years ago

aleb commented 8 years ago

Just two examples here, but there are more (at least in Gtk.Image): http://lazka.github.io/pgi-docs/#Gtk-3.0/classes/Button.html#Gtk.Button.new_from_icon_name http://lazka.github.io/pgi-docs/Gtk-3.0/classes/Image.html#Gtk.Image.new_from_gicon

lazka commented 8 years ago

The C code is currently annotated to int so we don't get that information, not sure why.

lazka commented 8 years ago

This introduced the int annotations: https://bugzilla.gnome.org/show_bug.cgi?id=601425

I think the best we can do is to include the type in the argument documentation so there is a link.

lazka commented 8 years ago

GTK+ bug: https://bugzilla.gnome.org/show_bug.cgi?id=757411

lazka commented 8 years ago

Fix pushed to gtk+ master, so it will be in 3.20

aleb commented 8 years ago

Thanks!