[Bug 719614] docs: add missing docs and fix errors

GStreamer (bugzilla.gnome.org) bugzilla at gnome.org
Mon Dec 2 16:16:24 PST 2013


https://bugzilla.gnome.org/show_bug.cgi?id=719614
  GStreamer | gstreamer (core) | git

Tim-Philipp Müller <t.i.m> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|UNCONFIRMED                 |RESOLVED
                 CC|                            |t.i.m at zen.co.uk
         Resolution|                            |FIXED
   Target Milestone|HEAD                        |1.3.1

--- Comment #8 from Tim-Philipp Müller <t.i.m at zen.co.uk> 2013-12-03 00:16:19 UTC ---
Pushed, many thanks:

commit 49950e57ad5f6eadbbe9d45d0ab3f7f7b4ce7577
Author: Sebastian Rasmussen <sebras at hotmail.com>
Date:   Sat Nov 30 12:15:37 2013 +0100

    docs: add missing docs, fixing doc errors

     * add many missing declarations to sections
     * GstController has been removed, update docs
     * skip GstIndex when generating documentation
     * rephrase so gtkdoc doesn't imagine return value
     * add missing argument description for gst_context_new()
     * document GstOutputSelectorPadNegotiationMode and move to header-file

    https://bugzilla.gnome.org/show_bug.cgi?id=719614

commit b40fa2b8c3485a8374186ca047622ab518e09485
Author: Sebastian Rasmussen <sebras at hotmail.com>
Date:   Sat Nov 30 14:52:40 2013 +0100

    docs: cosmetic changes in references/decriptions

     * fix typo GstBufferFlag -> GstBufferFlags
     * fix typo GstFeatures -> GstCapsFeatures
     * fix typo GstAllocatorParams -> GstAllocationParams
     * fix typo GstContrlSources -> GstControlSource
     * do not refer to gstcheck as an object
     * make references gtk_init() and tcase_set_timeout() not be references
     * gst_element_get_pad() renamed gst_element_get_static_pad()
     * gst_clock_id_wait_async_full() renamed gst_clock_id_wait_async()
     * _drop_element() is really gst_queue_array_drop_element()
     * gst_pad_accept_caps() was removed, do not refer to it
     * separate GST_META_TAG_MEMORY_STR declaration from description
     * do not describe removed gst_collect_pads_collect()
     * correctly link to GstElementClass' virtual set_context()

    Fixes https://bugzilla.gnome.org/show_bug.cgi?id=719614


Not so keen on the GstOutputSelectorPadNegotiationMode thing, but pushed it for
now. It's very confusing for people though to find these enums documented and
then not have header files they can include to make use of them. I think it's
another example of how gtk-doc doesn't work quite right for us with plugins
yet. Anyway, that just so you don't go and go on a property enum documentation
rampage for all the other modules ;)

-- 
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