After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 725517 - docs: Fix typos and remove unknown annotations
docs: Fix typos and remove unknown annotations
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: gstreamer (core)
git master
Other All
: Normal trivial
: 1.2.4
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2014-03-02 20:41 UTC by Sebastian Rasmussen
Modified: 2014-03-02 20:57 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Proposed patch to fix annotation typos an unknown tags. (2.24 KB, patch)
2014-03-02 20:42 UTC, Sebastian Rasmussen
committed Details | Review
docs: Fix typos and remove unknown annotations (2.26 KB, patch)
2014-03-02 20:51 UTC, Stefan Sauer (gstreamer, gtkdoc dev)
committed Details | Review

Description Sebastian Rasmussen 2014-03-02 20:41:10 UTC
When compiling the docs I notice these warnings:

gstbufferpool.c:1087: Warning: Gst: missing ":" at column 41:
 * @params: (transfer none) (allow-none) parameters.
                                        ^
gstmeta.c:153: Warning: Gst: missing ":" at column 29:
 * @init_func: (scope async) a #GstMetaInitFunction
                            ^
gstmeta.c:154: Warning: Gst: missing ":" at column 29:
 * @free_func: (scope async) a #GstMetaFreeFunction
                            ^
gstmeta.c:155: Warning: Gst: missing ":" at column 34:
 * @transform_func: (scope async) a #GstMetaTransformFunction
                                 ^

The propposed patch will remove these and remove the usage of
unrecognized (optional) and (replacement) annotations used in
GstBaseParseFrame. These two annotation tags are neither known
by gtk-doc nor by gobject-introspection.
Comment 1 Sebastian Rasmussen 2014-03-02 20:42:14 UTC
Created attachment 270717 [details] [review]
Proposed patch to fix annotation typos an unknown tags.
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2014-03-02 20:51:00 UTC
The following fix has been pushed:
034a3ab docs: Fix typos and remove unknown annotations
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2014-03-02 20:51:23 UTC
Created attachment 270719 [details] [review]
docs: Fix typos and remove unknown annotations

Fixes