mikey: fix a bunch of doc warnings

Rename header/source mismatch of parameters. Update the exposed API in
sections.txt.

diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt
index 83a5e7c..29a626e 100644 (file)
--- a/docs/libs/gst-plugins-base-libs-sections.txt
+++ b/docs/libs/gst-plugins-base-libs-sections.txt
@@ -1746,8 +1746,10 @@ GstMIKEYMessage
 gst_mikey_message_new
 gst_mikey_message_new_from_bytes
 gst_mikey_message_new_from_data
-gst_mikey_message_free
 gst_mikey_message_to_bytes
+gst_mikey_message_copy
+gst_mikey_message_ref
+gst_mikey_message_unref
 
 <SUBSECTION MessageInfo>
 GstMIKEYPRFFunc
@@ -1773,19 +1775,25 @@ gst_mikey_message_replace_payload
 gst_mikey_message_add_payload
 
 GstMIKEYPayloadType
-GstMIKEYPayloadClearFunc
-GstMIKEYPayloadCopyFunc
 GstMIKEYPayload
 gst_mikey_payload_new
 gst_mikey_payload_copy
-gst_mikey_payload_free
+gst_mikey_payload_key_data_set_interval
+gst_mikey_payload_key_data_set_key
+gst_mikey_payload_key_data_set_salt
+gst_mikey_payload_key_data_set_spi
+gst_mikey_payload_ref
+gst_mikey_payload_unref
 
 <SUBSECTION PayloadKEMAC>
 GstMIKEYEncAlg
 GstMIKEYMacAlg
 GstMIKEYPayloadKEMAC
 gst_mikey_payload_kemac_set
-gst_mikey_message_add_kemac
+gst_mikey_payload_kemac_add_sub
+gst_mikey_payload_kemac_get_n_sub
+gst_mikey_payload_kemac_get_sub
+gst_mikey_payload_kemac_remove_sub
 
 <SUBSECTION PayloadPKE>
 GstMIKEYCacheType
@@ -1817,6 +1825,10 @@ gst_mikey_payload_sp_get_param
 gst_mikey_payload_sp_add_param
 gst_mikey_payload_sp_remove_param
 <SUBSECTION Standard>
+GST_TYPE_MIKEY_MESSAGE
+gst_mikey_message_get_type
+GST_TYPE_MIKEY_PAYLOAD
+gst_mikey_payload_get_type
 </SECTION>
 
 # tag

diff --git a/gst-libs/gst/sdp/gstmikey.h b/gst-libs/gst/sdp/gstmikey.h
index 91d7be2..02635af 100644 (file)
--- a/gst-libs/gst/sdp/gstmikey.h
+++ b/gst-libs/gst/sdp/gstmikey.h
@@ -150,14 +150,14 @@ GType gst_mikey_payload_get_type(void);
  * GstMIKEYPayload:
  * @type: the payload type
  * @len: length of the payload
- * @clear_func: function to clear the payload
- * @copy_func: function to copy the payload
  *
  * Hold the common fields for all payloads
  */
 struct _GstMIKEYPayload {
+  /* < private > */
   GstMiniObject mini_object;
 
+  /* < public > */
   GstMIKEYPayloadType type;
   guint len;
 };
@@ -213,7 +213,7 @@ gst_mikey_payload_unref (GstMIKEYPayload * payload)
  * Since: 1.4
  */
 #ifdef _FOOL_GTK_DOC_
-G_INLINE_FUNC GstMIKEYPayload * gst_mikey_payload_copy (const GstMIKEYPayload * buf);
+G_INLINE_FUNC GstMIKEYPayload * gst_mikey_payload_copy (const GstMIKEYPayload * payload);
 #endif
 
 static inline GstMIKEYPayload *
@@ -255,7 +255,7 @@ typedef enum
  * @pt: the common #GstMIKEYPayload
  * @enc_alg: the #GstMIKEYEncAlg
  * @mac_alg: the #GstMIKEYMacAlg
- * @subpayload: the subpayloads
+ * @subpayloads: the subpayloads
  *
  * A structure holding the KEMAC payload
  */
@@ -537,8 +537,10 @@ gboolean   gst_mikey_payload_key_data_set_interval (GstMIKEYPayload *payload,
  */
 struct _GstMIKEYMessage
 {
+  /* < private > */
   GstMiniObject mini_object;
 
+  /* < public > */
   guint8 version;
   GstMIKEYType type;
   gboolean V;
@@ -606,7 +608,7 @@ gst_mikey_message_unref (GstMIKEYMessage * message)
  * Since: 1.4
  */
 #ifdef _FOOL_GTK_DOC_
-G_INLINE_FUNC GstMIKEYMessage * gst_mikey_message_copy (const GstMIKEYMessage * buf);
+G_INLINE_FUNC GstMIKEYMessage * gst_mikey_message_copy (const GstMIKEYMessage * message);
 #endif
 
 static inline GstMIKEYMessage *