GNOME Bugzilla – Bug 770520
Links to gstreamermm code snippets in GStreamer documentation
Last modified: 2018-11-03 11:03:22 UTC
Hi, At the beginning I'd like to emphasize, that it's just my idea I'd like to discuss with GStreamer core developers, not a GStreamer bug. However, bugzilla IMO seems to be better place to discuss it than mailing list. And to really get to the point, I was thinking if we could add links in GStreamer manual to gstreamermm examples with corresponding code snippets. E.g. there are two sample code blocks on the page: https://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/section-elements-create.html ; I could create gstreamermm examples for both, and we could add links to C++ version. If you think it's bad idea, and it'll only make documentation chaotic, it's fine - this is just an idea :) However, I think it might have a few advantages: 1) people will know about c++ interface. 2) it would be easier to learn gstreamermm, since we don't have separated guideline for the wrapper.
I think it would be better to have some examples in dedicated sections for various bindings, otherwise we're going to have 15 variations of all example code for all the bindings, and that just seems confusing then.
(In reply to Tim-Philipp Müller from comment #1) > otherwise we're going to have 15 variations of all example code That's how MSDN and the Apple thing are doing it btw, but they only show one at a time and you can switch between languages
(In reply to Sebastian Dröge (slomo) from comment #2) > That's how MSDN and the Apple thing are doing it btw, but they only show one > at a time and you can switch between languages Exactly. And to be honest, I really like it. Moreover, it shows the default language (which is probably C# for MSDN), but if user changes to another language, the configuration is saved in the cookies. I don't think we should do this for GStreamer Reference, but it could be nice feature if used in Application Development Manual.
> > otherwise we're going to have 15 variations of all example code > > That's how MSDN and the Apple thing are doing it btw, but they only > show one at a time and you can switch between languages Sure, and that's cool, but I don't see us doing that in the near future, and we have loads of other docs-related priorities first...
-- GitLab Migration Automatic Message -- This bug has been migrated to freedesktop.org's GitLab instance and has been closed from further activity. You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.freedesktop.org/gstreamer/gst-docs/issues/5.