docs: standardize GstClock documentation
authorMathieu Duponchelle <mathieu@centricular.com>
Fri, 12 Feb 2021 16:50:21 +0000 (17:50 +0100)
committerGStreamer Merge Bot <gitlab-merge-bot@gstreamer-foundation.org>
Mon, 15 Feb 2021 13:44:48 +0000 (13:44 +0000)
commitd5ae9f293a9a345808f07d79288e7f7a2a9efca6
tree53198796dea71f75bfea1dc25567e04e14e4b613
parent3952e19c2a9d2fc09a7567c625f5e77b730b0856
docs: standardize GstClock documentation

* Don't mention explicitly that API is MT safe, this implies that
  other API is not. GStreamer API is assumed to be MT safe, thread
  safety should only be explicitly mentioned when API is *not* MT safe

* 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 not critical here, as parameters do not
  need annotations / specific documentation, but serves as an up to
  date example

* Document enumeration members in standalone comments, so that their
  Since tag is accounted for by gobject-introspection

* Misc cleanup / typo fixes / addition of links

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