search

pygobject / pgi-docgen

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

Properties not listed #98

Closed aleb closed 8 years ago

aleb commented 9 years ago

http://lazka.github.io/pgi-docs/GES-1.0/classes/TitleSource.html#properties (GES 1.0 (1.4.0.0)) lists no direct properties. For example http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-editing-services/html/GESTitleSource.html (GES 1.0 (1.5.90)) lists 10.

lazka commented 9 years ago

Those aren't gobject properties, they are some GES only thing.

cfoch commented 9 years ago

so I suppose those should be implemented as gobject properties

aleb commented 9 years ago

Indeed, at least in Pitivi they seem to be set using http://lazka.github.io/pgi-docs/#GES-1.0/classes/TrackElement.html#GES.TrackElement.set_child_property instead of http://lazka.github.io/pgi-docs/#GObject-2.0/classes/Object.html#GObject.Object.set_property

Sorry for the confusion.

lazka commented 9 years ago

If there is a way to query those properties as ParamSpecs I can try including a special case. There is something similar for Gtk.Container using gtk_container_class_list_child_properties()

If found https://lazka.github.io/pgi-docs/#GES-1.0/classes/TrackElement.html#GES.TrackElement.list_children_properties

..but that returns an empty list(??) and needs an instance, but that's not a problem as long as it isn't an abstract class and has not mandatory construction properties.

any ideas?

thiblahute commented 9 years ago

The thing is that children properties are runtime dependent. It depends on the GstElement being used in the GESTrackElement.

For some subclasses of GESTrackElement I define/explain the ones that will always be present for example:

I might be missing other subtype where we could define some statically but then for some reason you lost that part of the doc in http://lazka.github.io/pgi-docs/#GES-1.0/classes/VideoSource.html#GES.VideoSource -- it would be nice to fix that :)

Apart from that I am not sure what could be done as it is really runtime dependent, and what the user is doing.

thiblahute commented 9 years ago

By the way this is how I define it:

https://phabricator.freedesktop.org/diffusion/GES/browse/master/ges/ges-video-source.c;1dc013984ba11ad195e3b39997b14894ee9f756a$25

The big problem here is that there is no way to create tables with gtk-doc markdown so I use docbook style ones.

lazka commented 9 years ago

I might be missing other subtype where we could define some statically but then for some reason you lost that part of the doc in http://lazka.github.io/pgi-docs/#GES-1.0/classes/VideoSource.html#GES.VideoSource -- it would be nice to fix that :)

I think I fixed that with http://cgit.freedesktop.org/gstreamer/gst-editing-services/commit/?id=a66e6746493a644cd005f873770ca53525edfc51 but that didn't make it into a release.

I'll try to include 1.5.90 some time, but debian sid is currently broken due to the stdc++ ABI transition and I can't install anything right now.

thiblahute commented 9 years ago

Cool, let me know if it fixes it :)

lazka commented 9 years ago

It's up now, but the docbook to rest code could be improved.

lazka commented 8 years ago

Closing this. For doc parsing improvements see #44