Bug#848297: gst-plugins-bad1.0: docstring collision

[Daniel Shahaf]

Package: gst-plugins-bad1.0
Version: 1.10.2-1
Severity: minor
Tags: patch upstream
User: reproducible-builds at lists.alioth.debian.org
Usertags: randomness

Dear Maintainer,

The documentation of GstColorEffectsPreset sometimes uses the docstring
of GstColorEffectsPreset and sometimes the docstring of GstMirrorMode [1]:

│   │   │   ├── ./usr/share/gtk-doc/html/gst-plugins-bad-plugins-1.0/gst-plugins-bad-plugins-coloreffects.html
│   │   │   │ @@ -188,15 +188,15 @@
│   │   │   │  <div class="refsect2">
│   │   │   │  <a name="GstColorEffectsPreset"></a><h3>enum GstColorEffectsPreset</h3>
│   │   │   │ -<p>How to split the video frame and which side reflect</p>
│   │   │   │ +<p>The lookup table to use to convert input colors</p>

I believe that that is caused by the docstring of GstMirrorMode
mistakenly referring to GstColorEffectsPreset:

[[[
diff --git a/gst/geometrictransform/gstmirror.h b/gst/geometrictransform/gstmirror.h
index 2084f2c..22e6aa5 100644
--- a/gst/geometrictransform/gstmirror.h
+++ b/gst/geometrictransform/gstmirror.h
@@ -66,7 +66,7 @@ typedef struct _GstMirror GstMirror;
 typedef struct _GstMirrorClass GstMirrorClass;
 
 /**
- * GstColorEffectsPreset:
+ * GstMirrorMode:
  * @GST_MIRROR_MODE_LEFT: Split horizontally and reflect left into right
  * @GST_MIRROR_MODE_RIGHT: Split horizontally and reflect right into left
  * @GST_MIRROR_MODE_TOP: Split horizontally and reflect top into bottom
]]]

Cheers,

Daniel

P.S. Apologies for not making a more thorough investigation; I would,
but for health reasons.

[1] https://tests.reproducible-builds.org/debian/rb-pkg/unstable/armhf/gst-plugins-bad1.0.html