GNOME Bugzilla – Bug 725521
docs: Fix argument and annotation typos, add missing annotations and remove duplicate section
Last modified: 2014-03-02 23:46:55 UTC
When compiling the documentation for -base I see the following warnings: colorbalance.c:118: Warning: GstVideo: unknown annotation: tranfer navigation.c:312: Warning: GstVideo: missing ":" at column 18: * @n_cmds: (out) the number of commands in this query. ^ navigation.c:343: Warning: GstVideo: missing ":" at column 15: * @cmd: (out) a pointer to store the nth command into. ^ video-format.c:29: Warning: GstVideo: multiple comment blocks documenting 'SECTION:gstvideo:' identifier (already seen at video.c:30). gstvideoutils.h:45: Warning: GstVideo: missing ":" at column 27: * @codec_data: (optional) a #GstBuffer corresponding to the ^ gstvideoutils.h:45: Warning: GstVideo: unknown annotation: optional video-color.c:133: Warning: GstVideo: gst_video_colorimetry_matches: unknown parameter 'info' in documentation comment, should be 'cinfo' video-color.c:157: Warning: GstVideo: gst_video_color_range_offsets: unknown parameter 'offsets' in documentation comment, should be 'offset' gstvideodecoder.c:3761: Warning: GstVideo: gst_video_decoder_merge_tags: unknown parameter 'decoder' in documentation comment, should be 'dec' video-format.c:2771: Warning: GstVideo: gst_video_format_get_palette: return value: Missing (transfer) annotation video-format.c:2771: Warning: GstVideo: gst_video_format_get_palette: return value: Missing (transfer) annotation gstsdpmessage.c:693: Warning: GstSdp: "@scheme" parameter unexpected at this location: * @scheme:///[#type=value *[&type=value]] ^ gstsdpmessage.c:693: Error: GstSdp: multiple "@scheme" parameters for identifier "gst_sdp_message_as_uri": * @scheme:///[#type=value *[&type=value]] ^ gstrtsptransport.c:276: Warning: GstRtsp: gst_rtsp_transport_get_media_type: unknown parameter 'mime' in documentation comment, should be 'media_type' gstrtspurl.c:396: Warning: GstRtsp: gst_rtsp_url_decode_path_components: return value: Missing (transfer) annotation gstrtspconnection.c:2755: Warning: GstRtsp: gst_rtsp_connection_get_write_socket: return value: Missing (transfer) annotation These are fixed by the attached patch-series. Let me know if they are in any way problematic.
Created attachment 270722 [details] [review] Proposed patch fixing argument and annotation typos
Created attachment 270723 [details] [review] Proposed patch adding annotations for some return values.
Created attachment 270724 [details] [review] Proposed patch removing duplicate section.
Docs fixes, yay! commit 900c204eb9e00d5fac6e8bb9fa86ce8ba4d428db Author: Sebastian Rasmussen <sebras@hotmail.com> Date: Sun Mar 2 12:58:21 2014 +0100 videoformat: Remove duplicate/incorrect section Fixes https://bugzilla.gnome.org/show_bug.cgi?id=725521 commit 35bb1b33286183e62efb54501fc6ed5d42fb3491 Author: Sebastian Rasmussen <sebras@hotmail.com> Date: Sun Mar 2 12:54:08 2014 +0100 docs: Add annotations for return values Rephrase and clarify some return value descriptions Fixes https://bugzilla.gnome.org/show_bug.cgi?id=725521 commit 5b4f2ba20bd8d31a3bed67b072755a6405d9ba42 Author: Sebastian Rasmussen <sebras@hotmail.com> Date: Sun Mar 2 05:06:07 2014 +0100 docs: Fix argument and annotation typos * colorbalance: Fix misspelled annotation * rtsp: Replace incorrectly documented function argument * sdp: Escape @ character to avoid gtk-doc warning * video-*: Add missing annotation colon * videodecoder/video-color: Fix function argument typos * videoutils: Remove unknown annotation field Fixes https://bugzilla.gnome.org/show_bug.cgi?id=725521 I think _get_palette() is not usable from bindings btw, but we can fix that if someone actually needs that ;)