doc: Fix hotdoc warnings

* Making sure that `static inline` function are in the GIR (by first defining them, and make sure to mark as skiped) * Do not try to link to unexisting symbols * Also generate GIR information about gst_tracers
2024-11-08 18:39:54 +00:00 · 2018-08-19 19:41:41 -03:00 · 2018-08-19 19:41:41 -03:00 · 949fba4b1f
commit 949fba4b1f
parent a0c65067e0
36 changed files with 139 additions and 71 deletions
--- a/docs/plugins/gst_plugins_cache.json
+++ b/docs/plugins/gst_plugins_cache.json
@ -1247,7 +1247,7 @@
                                "value": "0"
                            },
                            {
-                                "desc": "Line buffered",
+                                "desc": "Line buffered (deprecated, like full)",
                                "name": "line",
                                "value": "1"
                            },
--- a/gst/gstbuffer.c
+++ b/gst/gstbuffer.c
@ -2628,6 +2628,9 @@ _gst_parent_buffer_meta_init (GstParentBufferMeta * parent_meta,
  return TRUE;
 }

+/**
+ * gst_parent_buffer_meta_api_get_type: (attributes doc.skip=true)
+ */
 GType
 gst_parent_buffer_meta_api_get_type (void)
 {
@ -2796,6 +2799,9 @@ _gst_reference_timestamp_meta_init (GstReferenceTimestampMeta * meta,
  return TRUE;
 }

+/**
+ * gst_reference_timestamp_meta_api_get_type: (attributes doc.skip=true)
+ */
 GType
 gst_reference_timestamp_meta_api_get_type (void)
 {
--- a/gst/gstbuffer.h
+++ b/gst/gstbuffer.h
@ -412,7 +412,7 @@ gboolean       gst_buffer_unset_flags      (GstBuffer * buffer, GstBufferFlags f

 /* refcounting */
 /**
- * gst_buffer_ref:
+ * gst_buffer_ref: (skip)
 * @buf: a #GstBuffer.
 *
 * Increases the refcount of the given buffer by one.
@ -425,6 +425,7 @@ gboolean       gst_buffer_unset_flags      (GstBuffer * buffer, GstBufferFlags f
 *
 * Returns: (transfer full): @buf
 */
+static inline GstBuffer* gst_buffer_ref(GstBuffer* buf);
 static inline GstBuffer *
 gst_buffer_ref (GstBuffer * buf)
 {
@ -432,12 +433,13 @@ gst_buffer_ref (GstBuffer * buf)
 }

 /**
- * gst_buffer_unref:
+ * gst_buffer_unref: (skip)
 * @buf: (transfer full): a #GstBuffer.
 *
 * Decreases the refcount of the buffer. If the refcount reaches 0, the buffer
 * with the associated metadata and memory will be freed.
 */
+static inline void gst_buffer_unref(GstBuffer* buf);
 static inline void
 gst_buffer_unref (GstBuffer * buf)
 {
@ -465,7 +467,7 @@ gst_clear_buffer (GstBuffer ** buf_ptr)

 /* copy buffer */
 /**
- * gst_buffer_copy:
+ * gst_buffer_copy: (skip)
 * @buf: a #GstBuffer.
 *
 * Create a copy of the given buffer. This will only copy the buffer's
@ -476,6 +478,7 @@ gst_clear_buffer (GstBuffer ** buf_ptr)
 *
 * Returns: (transfer full): a new copy of @buf.
 */
+static inline GstBuffer* gst_buffer_copy(const GstBuffer* buf);
 static inline GstBuffer *
 gst_buffer_copy (const GstBuffer * buf)
 {
@ -577,7 +580,7 @@ gboolean        gst_buffer_copy_into            (GstBuffer *dest, GstBuffer *src
 #define         gst_buffer_make_writable(buf)   GST_BUFFER_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (buf)))

 /**
- * gst_buffer_replace:
+ * gst_buffer_replace: (skip)
 * @obuf: (inout) (transfer full) (nullable): pointer to a pointer to
 *     a #GstBuffer to be replaced.
 * @nbuf: (transfer none) (allow-none): pointer to a #GstBuffer that will
@ -592,6 +595,7 @@ gboolean        gst_buffer_copy_into            (GstBuffer *dest, GstBuffer *src
 *
 * Returns: %TRUE when @obuf was different from @nbuf.
 */
+static inline gboolean gst_buffer_replace(GstBuffer** obuf, GstBuffer* nbuf);
 static inline gboolean
 gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf)
 {
--- a/gst/gstbufferlist.h
+++ b/gst/gstbufferlist.h
@ -61,7 +61,7 @@ typedef gboolean   (*GstBufferListFunc)   (GstBuffer **buffer, guint idx,

 /* refcounting */
 /**
- * gst_buffer_list_ref:
+ * gst_buffer_list_ref: (skip)
 * @list: a #GstBufferList
 *
 * Increases the refcount of the given buffer list by one.
@ -73,6 +73,7 @@ typedef gboolean   (*GstBufferListFunc)   (GstBuffer **buffer, guint idx,
 *
 * Returns: (transfer full): @list
 */
+static inline GstBufferList* gst_buffer_list_ref(GstBufferList* list);
 static inline GstBufferList *
 gst_buffer_list_ref (GstBufferList * list)
 {
@ -81,14 +82,15 @@ gst_buffer_list_ref (GstBufferList * list)
 }

 /**
- * gst_buffer_list_unref:
+ * gst_buffer_list_unref: (skip)
 * @list: (transfer full): a #GstBufferList
 *
 * Decreases the refcount of the buffer list. If the refcount reaches 0, the
 * buffer list will be freed.
 */
+static inline void gst_buffer_list_unref(GstBufferList* list);
 static inline void
-gst_buffer_list_unref (GstBufferList * list)
+gst_buffer_list_unref(GstBufferList* list)
 {
  gst_mini_object_unref (GST_MINI_OBJECT_CAST (list));
 }
@ -114,7 +116,7 @@ gst_clear_buffer_list (GstBufferList ** list_ptr)

 /* copy */
 /**
- * gst_buffer_list_copy:
+ * gst_buffer_list_copy: (skip)
 * @list: a #GstBufferList
 *
 * Create a shallow copy of the given buffer list. This will make a newly
@ -123,6 +125,7 @@ gst_clear_buffer_list (GstBufferList ** list_ptr)
 *
 * Returns: (transfer full): a new copy of @list.
 */
+static inline GstBufferList* gst_buffer_list_copy(const GstBufferList* list);
 static inline GstBufferList *
 gst_buffer_list_copy (const GstBufferList * list)
 {
--- a/gst/gstcaps.h
+++ b/gst/gstcaps.h
@ -190,7 +190,7 @@ GST_API GstCaps * _gst_caps_none;

 /* refcounting */
 /**
- * gst_caps_ref:
+ * gst_caps_ref: (skip)
 * @caps: the #GstCaps to reference
 *
 * Add a reference to a #GstCaps object.
@ -204,6 +204,7 @@ GST_API GstCaps * _gst_caps_none;
 *
 * Returns: the same #GstCaps object.
 */
+static inline GstCaps * gst_caps_ref (GstCaps * caps);
 static inline GstCaps *
 gst_caps_ref (GstCaps * caps)
 {
@ -211,12 +212,13 @@ gst_caps_ref (GstCaps * caps)
 }

 /**
- * gst_caps_unref:
+ * gst_caps_unref: (skip)
 * @caps: a #GstCaps.
 *
 * Unref a #GstCaps and and free all its structures and the
 * structures' values when the refcount reaches 0.
 */
+static inline void gst_caps_unref (GstCaps * caps);
 static inline void
 gst_caps_unref (GstCaps * caps)
 {
@ -279,7 +281,7 @@ GstCaps * gst_caps_copy (const GstCaps * caps);
 #define         gst_caps_make_writable(caps)   GST_CAPS_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (caps)))

 /**
- * gst_caps_replace:
+ * gst_caps_replace: (skip)
 * @old_caps: (inout) (transfer full) (nullable): pointer to a pointer
 *     to a #GstCaps to be replaced.
 * @new_caps: (transfer none) (allow-none): pointer to a #GstCaps that will
@ -294,6 +296,7 @@ GstCaps * gst_caps_copy (const GstCaps * caps);
 *
 * Returns: %TRUE if @new_caps was different from @old_caps
 */
+static inline gboolean gst_caps_replace (GstCaps **old_caps, GstCaps *new_caps);
 static inline gboolean
 gst_caps_replace (GstCaps **old_caps, GstCaps *new_caps)
 {
@ -301,7 +304,7 @@ gst_caps_replace (GstCaps **old_caps, GstCaps *new_caps)
 }

 /**
- * gst_caps_take:
+ * gst_caps_take: (skip)
 * @old_caps: (inout) (transfer full): pointer to a pointer to a #GstCaps to be
 *     replaced.
 * @new_caps: (transfer full) (allow-none): pointer to a #GstCaps that will
@ -313,6 +316,7 @@ gst_caps_replace (GstCaps **old_caps, GstCaps *new_caps)
 *
 * Returns: %TRUE if @new_caps was different from @old_caps
 */
+static inline gboolean gst_caps_take (GstCaps **old_caps, GstCaps *new_caps);
 static inline gboolean
 gst_caps_take (GstCaps **old_caps, GstCaps *new_caps)
 {
@ -421,6 +425,9 @@ GstCaps *         gst_caps_new_full                (GstStructure  *struct1,
 GST_API
 GstCaps *         gst_caps_new_full_valist         (GstStructure  *structure,
                                                    va_list        var_args) G_GNUC_WARN_UNUSED_RESULT;
+/**
+ * gst_static_caps_get_type: (attributes doc.skip=true)
+ */
 GST_API
 GType             gst_static_caps_get_type         (void);

--- a/gst/gstcontrolbinding.h
+++ b/gst/gstcontrolbinding.h
@ -48,7 +48,10 @@ typedef struct _GstControlBindingPrivate GstControlBindingPrivate;

 #include <gst/gstcontrolsource.h>

-/* FIXME(2.0): remove, this is unused */
+/**
+ * GstControlBindingConvert: (attributes doc.skip=true)
+ * FIXME(2.0): remove, this is unused
+ */
 typedef void (* GstControlBindingConvert) (GstControlBinding *binding, gdouble src_value, GValue *dest_value);

 /**
--- a/gst/gstelement.h
+++ b/gst/gstelement.h
@ -373,8 +373,8 @@ G_STMT_START {                                                          \
 /**
 * GST_ELEMENT_ERROR_WITH_DETAILS:
 * @el:     the element that generates the error
- * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
- * @code:   error code defined for that domain (see #gstreamer-GstGError)
+ * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see [GstGError](gsterror.h))
+ * @code:   error code defined for that domain (see [GstGError](gsterror.h))
 * @text:   the message to display (format string and args enclosed in
            parentheses)
 * @debug:  debugging information for the message (format string and args
@ -406,8 +406,8 @@ G_STMT_START {                                                          \
 /**
 * GST_ELEMENT_ERROR:
 * @el:     the element that generates the error
- * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
- * @code:   error code defined for that domain (see #gstreamer-GstGError)
+ * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see [GstGError](gsterror.h))
+ * @code:   error code defined for that domain (see [GstGError](gsterror.h))
 * @text:   the message to display (format string and args enclosed in
            parentheses)
 * @debug:  debugging information for the message (format string and args
@ -434,8 +434,8 @@ G_STMT_START {                                                          \
 /**
 * GST_ELEMENT_WARNING_WITH_DETAILS:
 * @el:     the element that generates the warning
- * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
- * @code:   error code defined for that domain (see #gstreamer-GstGError)
+ * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see [GstGError](gsterror.h))
+ * @code:   error code defined for that domain (see [GstGError](gsterror.h))
 * @text:   the message to display (format string and args enclosed in
            parentheses)
 * @debug:  debugging information for the message (format string and args
@ -467,8 +467,8 @@ G_STMT_START {                                                          \
 /**
 * GST_ELEMENT_WARNING:
 * @el:     the element that generates the warning
- * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
- * @code:   error code defined for that domain (see #gstreamer-GstGError)
+ * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see [GstGError](gsterror.h))
+ * @code:   error code defined for that domain (see [GstGError](gsterror.h))
 * @text:   the message to display (format string and args enclosed in
            parentheses)
 * @debug:  debugging information for the message (format string and args
@ -495,8 +495,8 @@ G_STMT_START {                                                          \
 /**
 * GST_ELEMENT_INFO_WITH_DETAILS:
 * @el:     the element that generates the information
- * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
- * @code:   error code defined for that domain (see #gstreamer-GstGError)
+ * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see [GstGError](gsterror.h))
+ * @code:   error code defined for that domain (see [GstGError](gsterror.h))
 * @text:   the message to display (format string and args enclosed in
            parentheses)
 * @debug:  debugging information for the message (format string and args
@ -531,8 +531,8 @@ G_STMT_START {                                                          \
 /**
 * GST_ELEMENT_INFO:
 * @el:     the element that generates the information
- * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
- * @code:   error code defined for that domain (see #gstreamer-GstGError)
+ * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see [GstGError](gsterror.h))
+ * @code:   error code defined for that domain (see [GstGError](gsterror.h))
 * @text:   the message to display (format string and args enclosed in
            parentheses)
 * @debug:  debugging information for the message (format string and args
--- a/gst/gsterror.c
+++ b/gst/gsterror.c
@ -19,7 +19,7 @@

 /**
 * SECTION:gsterror
- * @title: GstError
+ * @title: GstGError
 * @short_description: Categorized error messages
 * @see_also: #GstMessage
 * @symbols:
--- a/gst/gsterror.h
+++ b/gst/gsterror.h
@ -245,15 +245,27 @@ typedef enum
 GST_API
 gchar *gst_error_get_message (GQuark domain, gint code);

+/**
+ * gst_stream_error_quark: (attributes doc.skip=true)
+ */
 GST_API
 GQuark gst_stream_error_quark (void);

+/**
+ * gst_core_error_quark: (attributes doc.skip=true)
+ */
 GST_API
 GQuark gst_core_error_quark (void);

+/**
+ * gst_resource_error_quark: (attributes doc.skip=true)
+ */
 GST_API
 GQuark gst_resource_error_quark (void);

+/**
+ * gst_library_error_quark: (attributes doc.skip=true)
+ */
 GST_API
 GQuark gst_library_error_quark (void);

--- a/gst/gstevent.h
+++ b/gst/gstevent.h
@ -313,7 +313,7 @@ GST_API GType _gst_event_type;
 */
 #define         gst_event_make_writable(ev)   GST_EVENT_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (ev)))
 /**
- * gst_event_replace:
+ * gst_event_replace: (skip)
 * @old_event: (inout) (transfer full) (nullable): pointer to a
 *     pointer to a #GstEvent to be replaced.
 * @new_event: (allow-none) (transfer none): pointer to a #GstEvent that will
@ -328,14 +328,15 @@ GST_API GType _gst_event_type;
 *
 * Returns: %TRUE if @new_event was different from @old_event
 */
+static inline gboolean gst_event_replace(GstEvent** old_event, GstEvent* new_event);
 static inline gboolean
-gst_event_replace (GstEvent **old_event, GstEvent *new_event)
+gst_event_replace(GstEvent** old_event, GstEvent* new_event)
 {
  return gst_mini_object_replace ((GstMiniObject **) old_event, (GstMiniObject *) new_event);
 }

 /**
- * gst_event_steal:
+ * gst_event_steal: (skip)
 * @old_event: (inout) (transfer full) (nullable): pointer to a
 *     pointer to a #GstEvent to be stolen.
 *
@ -344,6 +345,7 @@ gst_event_replace (GstEvent **old_event, GstEvent *new_event)
 *
 * Returns: the #GstEvent that was in @old_event
 */
+static inline GstEvent* gst_event_steal(GstEvent** old_event);
 static inline GstEvent *
 gst_event_steal (GstEvent **old_event)
 {
@ -351,7 +353,7 @@ gst_event_steal (GstEvent **old_event)
 }

 /**
- * gst_event_take:
+ * gst_event_take: (skip)
 * @old_event: (inout) (transfer full) (nullable): pointer to a
 *     pointer to a #GstEvent to be stolen.
 * @new_event: (allow-none) (transfer full): pointer to a #GstEvent that will
@ -365,6 +367,7 @@ gst_event_steal (GstEvent **old_event)
 *
 * Returns: %TRUE if @new_event was different from @old_event
 */
+static inline gboolean gst_event_take(GstEvent** old_event, GstEvent* new_event);
 static inline gboolean
 gst_event_take (GstEvent **old_event, GstEvent *new_event)
 {
@ -425,13 +428,14 @@ GstEventTypeFlags

 /* refcounting */
 /**
- * gst_event_ref:
+ * gst_event_ref: (skip)
 * @event: The event to refcount
 *
 * Increase the refcount of this event.
 *
 * Returns: (transfer full): @event (for convenience when doing assignments)
 */
+static inline GstEvent* gst_event_ref(GstEvent* event);
 static inline GstEvent *
 gst_event_ref (GstEvent * event)
 {
@ -439,11 +443,12 @@ gst_event_ref (GstEvent * event)
 }

 /**
- * gst_event_unref:
+ * gst_event_unref: (skip)
 * @event: (transfer full): the event to refcount
 *
 * Decrease the refcount of an event, freeing it if the refcount reaches 0.
 */
+static inline void gst_event_unref(GstEvent* event);
 static inline void
 gst_event_unref (GstEvent * event)
 {
@ -471,13 +476,14 @@ gst_clear_event (GstEvent ** event_ptr)

 /* copy event */
 /**
- * gst_event_copy:
+ * gst_event_copy: (skip)
 * @event: The event to copy
 *
 * Copy the event using the event specific copy function.
 *
 * Returns: (transfer full): the new event
 */
+static inline GstEvent* gst_event_copy(const GstEvent* event);
 static inline GstEvent *
 gst_event_copy (const GstEvent * event)
 {
--- a/gst/gstinfo.c
+++ b/gst/gstinfo.c
@ -72,7 +72,7 @@
 * So don't take addresses of these functions or use other tricks.
 * If you must do that for some reason, there is still an option.
 * If the debugging
- * subsystem was compiled out, #GST_DISABLE_GST_DEBUG is defined in
+ * subsystem was compiled out, GST_DISABLE_GST_DEBUG is defined in
 * &lt;gst/gst.h&gt;,
 * so you can check that before doing your trick.
 * Disabling the debugging subsystem will give you a slight (read: unnoticeable)
--- a/gst/gstinfo.h
+++ b/gst/gstinfo.h
@ -362,7 +362,9 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
    const gchar * func, gint line, GObject * obj, const gchar * msg,
    const guint8 * data, guint length);

-/* we define this to avoid a compiler warning regarding a cast from a function
+/**
+ * GstDebugFuncPtr: (attributes doc.skip=true)
+ * we define this to avoid a compiler warning regarding a cast from a function
 * pointer to a void pointer
 * (see https://bugzilla.gnome.org/show_bug.cgi?id=309253)
 */
--- a/gst/gstmemory.h
+++ b/gst/gstmemory.h
@ -320,13 +320,14 @@ gboolean       gst_memory_is_type      (GstMemory *mem, const gchar *mem_type);

 /* refcounting */
 /**
- * gst_memory_ref:
+ * gst_memory_ref: (skip)
 * @memory: The memory to refcount
 *
 * Increase the refcount of this memory.
 *
 * Returns: (transfer full): @memory (for convenience when doing assignments)
 */
+static inline GstMemory* gst_memory_ref(GstMemory* memory);
 static inline GstMemory *
 gst_memory_ref (GstMemory * memory)
 {
@ -334,11 +335,12 @@ gst_memory_ref (GstMemory * memory)
 }

 /**
- * gst_memory_unref:
+ * gst_memory_unref: (skip)
 * @memory: (transfer full): the memory to refcount
 *
 * Decrease the refcount of an memory, freeing it if the refcount reaches 0.
 */
+static inline void gst_memory_unref(GstMemory* memory);
 static inline void
 gst_memory_unref (GstMemory * memory)
 {
--- a/gst/gstmessage.h
+++ b/gst/gstmessage.h
@ -356,13 +356,14 @@ GQuark          gst_message_type_to_quark       (GstMessageType type);

 /* refcounting */
 /**
- * gst_message_ref:
+ * gst_message_ref: (skip)
 * @msg: the message to ref
 *
 * Convenience macro to increase the reference count of the message.
 *
 * Returns: @msg (for convenience when doing assignments)
 */
+static inline GstMessage * gst_message_ref (GstMessage * msg);
 static inline GstMessage *
 gst_message_ref (GstMessage * msg)
 {
@ -370,12 +371,13 @@ gst_message_ref (GstMessage * msg)
 }

 /**
- * gst_message_unref:
+ * gst_message_unref: (skip)
 * @msg: the message to unref
 *
 * Convenience macro to decrease the reference count of the message, possibly
 * freeing it.
 */
+static inline void gst_message_unref (GstMessage * msg);
 static inline void
 gst_message_unref (GstMessage * msg)
 {
@ -403,7 +405,7 @@ gst_clear_message (GstMessage ** msg_ptr)

 /* copy message */
 /**
- * gst_message_copy:
+ * gst_message_copy: (skip)
 * @msg: the message to copy
 *
 * Creates a copy of the message. Returns a copy of the message.
@ -412,6 +414,7 @@ gst_clear_message (GstMessage ** msg_ptr)
 *
 * MT safe
 */
+static inline GstMessage * gst_message_copy (const GstMessage * msg);
 static inline GstMessage *
 gst_message_copy (const GstMessage * msg)
 {
@ -439,7 +442,7 @@ gst_message_copy (const GstMessage * msg)
 */
 #define         gst_message_make_writable(msg)  GST_MESSAGE_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (msg)))
 /**
- * gst_message_replace:
+ * gst_message_replace: (skip)
 * @old_message: (inout) (transfer full) (nullable): pointer to a
 *     pointer to a #GstMessage to be replaced.
 * @new_message: (allow-none) (transfer none): pointer to a #GstMessage that will
@ -454,6 +457,7 @@ gst_message_copy (const GstMessage * msg)
 *
 * Returns: %TRUE if @new_message was different from @old_message
 */
+static inline gboolean gst_message_replace (GstMessage **old_message, GstMessage *new_message);
 static inline gboolean
 gst_message_replace (GstMessage **old_message, GstMessage *new_message)
 {
--- a/gst/gstminiobject.c
+++ b/gst/gstminiobject.c
@ -948,7 +948,7 @@ gst_mini_object_get_qdata (GstMiniObject * object, GQuark quark)
 * @quark: A #GQuark, naming the user data pointer
 *
 * This function gets back user data pointers stored via gst_mini_object_set_qdata()
- * and removes the data from @object without invoking its destroy() function (if
+ * and removes the data from @object without invoking its `destroy()` function (if
 * any was set).
 *
 * Returns: (transfer full) (nullable): The user data pointer set, or
--- a/gst/gstpad.c
+++ b/gst/gstpad.c
@ -43,7 +43,7 @@
 * then a guaranteed unique name will be assigned to it.
 *
 * A #GstElement creating a pad will typically use the various
- * gst_pad_set_*_function() calls to register callbacks for events, queries or
+ * gst_pad_set_*_function\() calls to register callbacks for events, queries or
 * dataflow on the pads.
 *
 * gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
--- a/gst/gstpadtemplate.h
+++ b/gst/gstpadtemplate.h
@ -200,6 +200,9 @@ struct _GstStaticPadTemplate {
 GST_API
 GType			gst_pad_template_get_type		(void);

+/**
+ * gst_static_pad_template_get_type: (attributes doc.skip=true)
+ */
 GST_API
 GType			gst_static_pad_template_get_type	(void);

--- a/gst/gstpromise.c
+++ b/gst/gstpromise.c
@ -32,7 +32,6 @@ GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
 * SECTION:gstpromise
 * @title: GstPromise
 * @short_description: a miniobject for future/promise-like functionality
- * @see_also:
 *
 * The #GstPromise object implements the container for values that may
 * be available later. i.e. a Future or a Promise in
--- a/gst/gstprotection.h
+++ b/gst/gstprotection.h
@ -70,6 +70,9 @@ struct _GstProtectionMeta
  GstStructure *info;
 };

+/**
+ * gst_protection_meta_api_get_type: (attributes doc.skip=true)
+ */
 GST_API
 GType gst_protection_meta_api_get_type (void);

--- a/gst/gstquery.h
+++ b/gst/gstquery.h
@ -244,12 +244,13 @@ gst_query_ref (GstQuery * q)
 }

 /**
- * gst_query_unref:
+ * gst_query_unref: (skip)
 * @q: a #GstQuery to decrease the refcount of.
 *
 * Decreases the refcount of the query. If the refcount reaches 0, the query
 * will be freed.
 */
+static inline void gst_query_unref(GstQuery* q);
 static inline void
 gst_query_unref (GstQuery * q)
 {
@ -277,7 +278,7 @@ gst_clear_query (GstQuery ** query_ptr)

 /* copy query */
 /**
- * gst_query_copy:
+ * gst_query_copy: (skip)
 * @q: a #GstQuery to copy.
 *
 * Copies the given query using the copy function of the parent #GstStructure.
@ -286,6 +287,7 @@ gst_clear_query (GstQuery ** query_ptr)
 *
 * Returns: (transfer full): a new copy of @q.
 */
+static inline GstQuery* gst_query_copy(const GstQuery* q);
 static inline GstQuery *
 gst_query_copy (const GstQuery * q)
 {
@ -309,7 +311,7 @@ gst_query_copy (const GstQuery * q)
 */
 #define         gst_query_make_writable(q)      GST_QUERY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (q)))
 /**
- * gst_query_replace:
+ * gst_query_replace: (skip)
 * @old_query: (inout) (transfer full) (nullable): pointer to a pointer to a
 *     #GstQuery to be replaced.
 * @new_query: (allow-none) (transfer none): pointer to a #GstQuery that will
@ -324,6 +326,7 @@ gst_query_copy (const GstQuery * q)
 *
 * Returns: %TRUE if @new_query was different from @old_query
 */
+static inline gboolean gst_query_replace(GstQuery** old_query, GstQuery* new_query);
 static inline gboolean
 gst_query_replace (GstQuery **old_query, GstQuery *new_query)
 {
--- a/gst/gstsample.h
+++ b/gst/gstsample.h
@ -89,13 +89,14 @@ gboolean             gst_sample_set_info      (GstSample *sample, GstStructure *

 /* refcounting */
 /**
- * gst_sample_ref:
+ * gst_sample_ref: (skip)
 * @sample: a #GstSample
 *
 * Increases the refcount of the given sample by one.
 *
 * Returns: (transfer full): @sample
 */
+static inline GstSample* gst_sample_ref(GstSample* sample);
 static inline GstSample *
 gst_sample_ref (GstSample * sample)
 {
@ -104,12 +105,13 @@ gst_sample_ref (GstSample * sample)
 }

 /**
- * gst_sample_unref:
+ * gst_sample_unref: (skip)
 * @sample: (transfer full): a #GstSample
 *
 * Decreases the refcount of the sample. If the refcount reaches 0, the
 * sample will be freed.
 */
+static inline void gst_sample_unref(GstSample* sample);
 static inline void
 gst_sample_unref (GstSample * sample)
 {
@ -157,7 +159,7 @@ gst_sample_unref (GstSample * sample)

 /* copy sample */
 /**
- * gst_sample_copy:
+ * gst_sample_copy: (skip)
 * @buf: a #GstSample.
 *
 * Create a copy of the given sample. This will also make a newly allocated
@ -167,6 +169,7 @@ gst_sample_unref (GstSample * sample)
 *
 * Since: 1.2
 */
+static inline GstSample* gst_sample_copy(const GstSample* buf);
 static inline GstSample *
 gst_sample_copy (const GstSample * buf)
 {
--- a/gst/gststructure.c
+++ b/gst/gststructure.c
@ -2725,7 +2725,7 @@ wrong_type:
 * The last variable argument should be %NULL.
 *
 * For refcounted (mini)objects you will receive a new reference which
- * you must release with a suitable _unref() when no longer needed. For
+ * you must release with a suitable _unref\() when no longer needed. For
 * strings and boxed types you will receive a copy which you will need to
 * release with either g_free() or the suitable function for the boxed type.
 *
@ -2768,7 +2768,7 @@ gst_structure_get (const GstStructure * structure, const char *first_fieldname,
 * quark hashtable.
 *
 * For refcounted (mini)objects you will receive a new reference which
- * you must release with a suitable _unref() when no longer needed. For
+ * you must release with a suitable _unref\() when no longer needed. For
 * strings and boxed types you will receive a copy which you will need to
 * release with either g_free() or the suitable function for the boxed type.
 *
--- a/gst/gsttaglist.h
+++ b/gst/gsttaglist.h
@ -450,7 +450,7 @@ gboolean     gst_tag_list_get_sample_index  (const GstTagList * list,

 /* refcounting */
 /**
- * gst_tag_list_ref:
+ * gst_tag_list_ref: (skip)
 * @taglist: the #GstTagList to reference
 *
 * Add a reference to a #GstTagList mini object.
@ -463,6 +463,7 @@ gboolean     gst_tag_list_get_sample_index  (const GstTagList * list,
 *
 * Returns: the same #GstTagList mini object.
 */
+static inline GstTagList* gst_tag_list_ref(GstTagList* taglist);
 static inline GstTagList *
 gst_tag_list_ref (GstTagList * taglist)
 {
@ -470,11 +471,12 @@ gst_tag_list_ref (GstTagList * taglist)
 }

 /**
- * gst_tag_list_unref:
+ * gst_tag_list_unref: (skip)
 * @taglist: a #GstTagList.
 *
 * Unref a #GstTagList, and and free all its memory when the refcount reaches 0.
 */
+static inline void gst_tag_list_unref(GstTagList* taglist);
 static inline void
 gst_tag_list_unref (GstTagList * taglist)
 {
@ -501,7 +503,7 @@ gst_clear_tag_list (GstTagList ** taglist_ptr)
 }

 /**
- * gst_tag_list_copy:
+ * gst_tag_list_copy: (skip)
 * @taglist: a #GstTagList.
 *
 * Creates a new #GstTagList as a copy of the old @taglist. The new taglist
@ -516,6 +518,7 @@ gst_clear_tag_list (GstTagList ** taglist_ptr)
 *
 * Returns: the new #GstTagList
 */
+static inline GstTagList* gst_tag_list_copy(const GstTagList* taglist);
 static inline GstTagList *
 gst_tag_list_copy (const GstTagList * taglist)
 {
--- a/gst/gsttypefind.h
+++ b/gst/gsttypefind.h
@ -91,6 +91,9 @@ struct _GstTypeFind {
  gpointer _gst_reserved[GST_PADDING];
 };

+/**
+ * gst_type_find_get_type: (attributes doc.skip=true)
+ */
 GST_API
 GType     gst_type_find_get_type   (void);

--- a/gst/gsturi.c
+++ b/gst/gsturi.c
@ -900,7 +900,7 @@ file_path_contains_relatives (const gchar * path)
 * the current working directory if it is a relative path, and then the path
 * will be canonicalised so that it doesn't contain any './' or '../' segments.
 *
- * On Windows #filename should be in UTF-8 encoding.
+ * On Windows @filename should be in UTF-8 encoding.
 *
 * Returns: newly-allocated URI string, or NULL on error. The caller must
 *   free the URI string with g_free() when no longer needed.
--- a/gst/gsturi.h
+++ b/gst/gsturi.h
@ -33,6 +33,9 @@ G_BEGIN_DECLS

 #include <gst/gstconfig.h>

+/**
+ * gst_uri_error_quark: (attributes doc.skip=true)
+ */
 GST_API
 GQuark gst_uri_error_quark (void);

--- a/gst/gstvalue.h
+++ b/gst/gstvalue.h
@ -65,7 +65,7 @@ G_BEGIN_DECLS
 * GST_FOURCC_FORMAT: (skip):
 *
 * Can be used together with #GST_FOURCC_ARGS to properly output a
- * #guint32 fourcc value in a printf()-style text message.
+ * #guint32 fourcc value in a printf\()-style text message.
 *
 * |[
 * printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc));
@ -79,7 +79,7 @@ G_BEGIN_DECLS
 * @fourcc: a #guint32 fourcc value to output
 *
 * Can be used together with #GST_FOURCC_FORMAT to properly output a
- * #guint32 fourcc value in a printf()-style text message.
+ * #guint32 fourcc value in a printf\()-style text message.
 */

 #define __GST_PRINT_CHAR(c) \
--- a/gst/meson.build
+++ b/gst/meson.build
@ -251,7 +251,7 @@ libgst = library('gstreamer-1.0', gst_sources,
 )

 if build_gir
-  gst_gir_extra_args = gir_init_section + [ '--c-include=gst/gst.h' ]
+  gst_gir_extra_args = gir_init_section + [ '--c-include=gst/gst.h', '-DGST_USE_UNSTABLE_API' ]
  if meson.is_subproject()
    # FIXME: There must be a better way to do this
    # Need to pass the include path to find gst/gst.h and gst/gstenumtypes.h (built)
--- a/libs/gst/base/gstadapter.c
+++ b/libs/gst/base/gstadapter.c
@ -106,8 +106,8 @@
 * since then can be queried with gst_adapter_distance_from_discont().
 *
 * A last thing to note is that while #GstAdapter is pretty optimized,
- * merging buffers still might be an operation that requires a malloc() and
- * memcpy() operation, and these operations are not the fastest. Because of
+ * merging buffers still might be an operation that requires a `malloc()` and
+ * `memcpy()` operation, and these operations are not the fastest. Because of
 * this, some functions like gst_adapter_available_fast() are provided to help
 * speed up such cases should you want to. To avoid repeated memory allocations,
 * gst_adapter_copy() can be used to copy data into a (statically allocated)
--- a/libs/gst/base/gstaggregator.c
+++ b/libs/gst/base/gstaggregator.c
@ -76,7 +76,7 @@
 * @short_description: #GstPad subclass for pads managed by #GstAggregator
 * @see_also: gstcollectpads for historical reasons.
 *
- * Pads managed by a #GstAggregor subclass.
+ * Pads managed by a #GstAggregator subclass.
 *
 * This class used to live in gst-plugins-bad and was moved to core.
 *
@ -3289,7 +3289,7 @@ gst_aggregator_get_allocator (GstAggregator * self,
 * gst_aggregator_simple_get_next_time:
 * @self: A #GstAggregator
 *
- * This is a simple #GstAggregator::get_next_time implementation that
+ * This is a simple #GstAggregatorClass.get_next_time() implementation that
 * just looks at the #GstSegment on the srcpad of the aggregator and bases
 * the next time on the running time there.
 *
--- a/libs/gst/base/gstbaseparse.c
+++ b/libs/gst/base/gstbaseparse.c
@ -111,7 +111,7 @@
 *
 *  * During the parsing process #GstBaseParseClass will handle both srcpad
 *    and sinkpad events. They will be passed to subclass if
- *    #GstBaseParseClass.event() or #GstBaseParseClass.src_event()
+ *    #GstBaseParseClass.sink_event() or #GstBaseParseClass.src_event()
 *    implementations have been provided.
 *
 * ## Shutdown phase
--- a/libs/gst/base/gstbasesrc.c
+++ b/libs/gst/base/gstbasesrc.c
@ -659,7 +659,7 @@ gst_base_src_set_dynamic_size (GstBaseSrc * src, gboolean dynamic)
 * When @src operates in %GST_FORMAT_TIME, #GstBaseSrc will send an EOS
 * when a buffer outside of the currently configured segment is pushed if
 * @automatic_eos is %TRUE. Since 1.16, if @automatic_eos is %FALSE an
- * EOS will be pushed only when the #GstBaseSrc.create implementation
+ * EOS will be pushed only when the #GstBaseSrcClass.create() implementation
 * returns %GST_FLOW_EOS.
 *
 * Since: 1.4
@ -856,7 +856,7 @@ gst_base_src_get_do_timestamp (GstBaseSrc * src)
 * @time: The new time value for the start of the new segment
 *
 * Prepare a new seamless segment for emission downstream. This function must
- * only be called by derived sub-classes, and only from the create() function,
+ * only be called by derived sub-classes, and only from the #GstBaseSrcClass::create function,
 * as the stream-lock needs to be held.
 *
 * The format for the new segment will be the current format of the source, as
--- a/libs/gst/base/gstbasesrc.h
+++ b/libs/gst/base/gstbasesrc.h
@ -142,7 +142,7 @@ struct _GstBaseSrc {
 *   segment in that format.
 * @do_seek: Perform seeking on the resource to the indicated segment.
 * @unlock: Unlock any pending access to the resource. Subclasses should unblock
- *    any blocked function ASAP. In particular, any create() function in
+ *    any blocked function ASAP. In particular, any `create()` function in
 *    progress should be unblocked and should return GST_FLOW_FLUSHING. Any
 *    future #GstBaseSrcClass.create() function call should also return
 *    GST_FLOW_FLUSHING until the #GstBaseSrcClass.unlock_stop() function has
--- a/libs/gst/base/gstcollectpads.c
+++ b/libs/gst/base/gstcollectpads.c
@ -24,7 +24,6 @@
 * SECTION:gstcollectpads
 * @title: GstCollectPads
 * @short_description: manages a set of pads that operate in collect mode
- * @see_also:
 *
 * Manages a set of pads that operate in collect mode. This means that control
 * is given to the manager of this object when all pads have data.
--- a/libs/gst/controller/gstproxycontrolbinding.c
+++ b/libs/gst/controller/gstproxycontrolbinding.c
@ -170,7 +170,7 @@ gst_proxy_control_binding_class_init (GstProxyControlBindingClass * klass)
 *              #GstControlBinding requests to
 * @ref_property_name: the property_name in @ref_object to control
 *
- * #GstProxyControlBinding forwards all access to data or sync_values()
+ * #GstProxyControlBinding forwards all access to data or `sync_values()`
 * requests from @property_name on @object to the control binding at
 * @ref_property_name on @ref_object.
 *
--- a/libs/gst/net/gstnetclientclock.c
+++ b/libs/gst/net/gstnetclientclock.c
@ -1415,7 +1415,7 @@ gst_net_client_clock_get_internal_time (GstClock * clock)
 * @remote_port: the port of the remote clock provider
 * @base_time: initial time of the clock
 *
- * Create a new #GstNetClientInternalClock that will report the time
+ * Create a new #GstNetClientClock that will report the time
 * provided by the #GstNetTimeProvider on @remote_address and
 * @remote_port.
 *