Use gtk-doc comments (review pull request #632) port-changes-from-branch-2.x.y-to-default

Thu, 19 Dec 2019 14:25:49 +0100

author
Fabrice Bellet <fabrice@bellet.info>
date
Thu, 19 Dec 2019 14:25:49 +0100
branch
port-changes-from-branch-2.x.y-to-default
changeset 40273
a8cee989c2ab
parent 40272
119f63eae90e
child 40274
4f159034c598

Use gtk-doc comments (review pull request #632)

libpurple/media.h file | annotate | diff | comparison | revisions
libpurple/media/backend-iface.h file | annotate | diff | comparison | revisions
--- a/libpurple/media.h	Thu Oct 03 13:44:09 2019 +0200
+++ b/libpurple/media.h	Thu Dec 19 14:25:49 2019 +0100
@@ -412,14 +412,15 @@
 		const gchar *key, gsize key_len);
 
 /**
+ * purple_media_set_require_encryption:
+ * @media: The media object to find the session in.
+ * @sess_id: The id of the session to set parameters of.
+ * @participant: The participant of the session to set parameters of.
+ * @require_encryption: TRUE if the media requires encryption.
+ *
  * Sets whether a session participant's media requires encryption.
  *
- * @param media The media object to find the session in.
- * @param sess_id The id of the session to set parameters of.
- * @param participant The participant of the session to set parameters of.
- * @param require_encryption TRUE if the media requires encryption.
- *
- * @since 2.14.0
+ * Since: 2.14.0
  */
 gboolean purple_media_set_require_encryption(PurpleMedia *media,
 		const gchar *sess_id, const gchar *participant,
--- a/libpurple/media/backend-iface.h	Thu Oct 03 13:44:09 2019 +0200
+++ b/libpurple/media/backend-iface.h	Thu Dec 19 14:25:49 2019 +0100
@@ -258,10 +258,10 @@
 
 /**
  * purple_media_backend_set_require_encryption:
- * @self The media object to find the session in.
- * @sess_id The id of the session to set parameters of.
- * @participant The participant of the session to set parameters of.
- * @require_encryption TRUE if the media requires encryption.
+ * @self: The media object to find the session in.
+ * @sess_id: The id of the session to set parameters of.
+ * @participant: The participant of the session to set parameters of.
+ * @require_encryption: TRUE if the media requires encryption.
  *
  * Sets whether a session participant's media requires encryption.
  */

mercurial