gstreamer: doc: Workaround gtkdoc issue

Stefan Sauer ensonic at hora-obscura.de
Sun May 17 07:16:57 PDT 2015


On 05/17/2015 05:32 AM, Nicolas Dufresne wrote:
> Module: gstreamer
> Branch: master
> Commit: 460a7bf68292d057c77e84d1ea86b8e73fc081f3
> URL:    http://cgit.freedesktop.org/gstreamer/gstreamer/commit/?id=460a7bf68292d057c77e84d1ea86b8e73fc081f3
>
> Author: Nicolas Dufresne <nicolas.dufresne at collabora.co.uk>
> Date:   Sat May 16 23:29:03 2015 -0400
>
> doc: Workaround gtkdoc issue
>
> With gtkdoc 1.22, the XML generator fails when a itemizedlist is
> followed by a refsect2. Workaround the issue by wrapping the refsect2
> into para.
I just released 1.23 to fix the regression. Also this would be invalid xml.

Stefan


>
> ---
>
>  plugins/elements/gstfdsrc.c |    2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/plugins/elements/gstfdsrc.c b/plugins/elements/gstfdsrc.c
> index cebca21..c655125 100644
> --- a/plugins/elements/gstfdsrc.c
> +++ b/plugins/elements/gstfdsrc.c
> @@ -44,6 +44,7 @@
>   * </listitem>
>   * </itemizedlist>
>   *
> + * <para>
>   * <refsect2>
>   * <title>Example launch line</title>
>   * |[
> @@ -51,6 +52,7 @@
>   * ]| A simple pipeline to read from the standard input and dump the data
>   * with a fakesink as hex ascii block.
>   * </refsect2>
> + * </para>
>   */
>  
>  #ifdef HAVE_CONFIG_H
>
> _______________________________________________
> gstreamer-commits mailing list
> gstreamer-commits at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/gstreamer-commits



More information about the gstreamer-devel mailing list