[Bug 725521] New: docs: Fix argument and annotation typos, add missing annotations and remove duplicate section

GStreamer (bugzilla.gnome.org) bugzilla at gnome.org
Sun Mar 2 12:38:34 PST 2014


https://bugzilla.gnome.org/show_bug.cgi?id=725521
  GStreamer | gst-plugins-base | git

           Summary: docs: Fix argument and annotation typos, add missing
                    annotations and remove duplicate section
    Classification: Platform
           Product: GStreamer
           Version: git
        OS/Version: All
            Status: UNCONFIRMED
          Severity: trivial
          Priority: Normal
         Component: gst-plugins-base
        AssignedTo: gstreamer-bugs at lists.freedesktop.org
        ReportedBy: sebras at hotmail.com
         QAContact: gstreamer-bugs at lists.freedesktop.org
     GNOME version: ---


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.

-- 
Configure bugmail: https://bugzilla.gnome.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA contact for the bug.
You are the assignee for the bug.


More information about the gstreamer-bugs mailing list