Element-Level Documentation?

Stefan Sauer ensonic at hora-obscura.de
Thu Jun 20 13:58:43 PDT 2013


On 06/18/2013 08:15 PM, Stirling Westrup wrote:
> Lately I've been finding that I'm having to read a lot of element
> source code in order to find the doxygen descriptions embedded in it,
> that tells me what the element actually does and what its properties
> actually control and how.
>
> This information currently shows up neither as part of
> gst-inspect-1.0's output, nor does it show up in either the
> Application guide or the Plugin Writer's guide.
>
> Is there any make parameter to have this element-level doxygen
> information collected and published as a PDF so that I have a handy
> reference without having to keep going back to the element sources?

The markup, is what gtk-doc digests. Install devhelp (on linux) and read
it. If you built the git version yourself, make sure you have gtk-doc
installed and are not using --disable-gtkdoc when building.

Stefan
>
> -- 
> Stirling Westrup
> Programmer, Entrepreneur.
> https://www.linkedin.com/e/fpf/77228
> http://www.linkedin.com/in/swestrup
> http://technaut.livejournal.com
> http://sourceforge.net/users/stirlingwestrup
>
>
> _______________________________________________
> gstreamer-devel mailing list
> gstreamer-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/gstreamer-devel

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.freedesktop.org/archives/gstreamer-devel/attachments/20130620/e180b0a1/attachment.html>


More information about the gstreamer-devel mailing list