gstreamer-rs documentation

[Russel Winder]

Hi,

The Gstreamer_Rs documentation often presents the API but fails to have the
commentary and examples. Is there any chance of just copying in the C
documentation for each struct, method, and function where there is no manual
documentation so as to avoid having to have both the Rust API documentation
and the C documentation open and manually collating information?

GtkD (which includes GStreamerD) does this and whilst it is really annoying
that the documentation presents the C rather than the D, it is very much
easier working out what the D needs to be having the C stuff immediately
available.

cf.  https://docs.rs/gstreamer/0.13.0/gstreamer/buffer/struct.BufferRef.html
as an example of an irritant.

--
Russel.
===========================================
Dr Russel Winder      t: [phone]
41 Buckmaster Road    m: [phone]
London SW11 1EN, UK   w: www.russel.org.uk


_______________________________________________
gstreamer-devel mailing list
[hidden email]
https://lists.freedesktop.org/mailman/listinfo/gstreamer-devel

[Sebastian Dröge-3]

On Mon, 2019-04-01 at 07:23 +0100, Russel Winder wrote:
> Hi,
>
> The Gstreamer_Rs documentation often presents the API but fails to have the
> commentary and examples. Is there any chance of just copying in the C
> documentation for each struct, method, and function where there is no manual
> documentation so as to avoid having to have both the Rust API documentation
> and the C documentation open and manually collating information?

Yes, check here:
 https://slomo.pages.freedesktop.org/rustdocs/gstreamer/gstreamer/

Or if you build yourself the documentation, enable the
"embed-lgpl-docs" cargo feature.


rustdoc requires the documentation to be embedded in the code, but as
GStreamer is LGPL (and there is no separate license for the gtk-doc
documentation) this would also make the Rust bindings covered by the
LGPL (and that's suboptimal because of static linking). With this hack,
the gtk-doc based documentation that is extracted from the .gir file is
kept separate and only injected into the code when when explicitly
requested.

--
Sebastian Dröge, Centricular Ltd · https://www.centricular.com


_______________________________________________
gstreamer-devel mailing list
[hidden email]
https://lists.freedesktop.org/mailman/listinfo/gstreamer-devel