docs: standardize GstBufferPool documentation
authorMathieu Duponchelle <mathieu@centricular.com>
Mon, 8 Feb 2021 14:17:05 +0000 (15:17 +0100)
committerMathieu Duponchelle <mathieu@centricular.com>
Mon, 8 Feb 2021 14:17:05 +0000 (15:17 +0100)
commit12639aad34fb6346a938a0f16e4151a88378f816
tree480b50fab47e125a1ddf0bdf50b156ce5f8f47c7
parent85763437c7fa0aace72571223d77fbfe29a65be9
docs: standardize GstBufferPool documentation

* Don't repeat what annotations are stating with respect to ownership
  transfer, nullability

* Document virtual methods in standalone comments, so that parameters
  can be documented. This is functionally useful here, as parameters
  require annotations, and should make the class more usable by
  bindings.

* Misc cleanup / typo fixes / addition of links

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/752>
gst/gstbufferpool.c
gst/gstbufferpool.h