pidgin/pidgin

Use gtk-doc comments (review pull request #632)
port-changes-from-branch-2.x.y-to-default
2019-12-19, Fabrice Bellet
a8cee989c2ab
Parents 119f63eae90e
Children 4f159034c598
Use gtk-doc comments (review pull request #632)
2 files changed, 11 insertions(+), 10 deletions(-)
  • +7 -6
    libpurple/media.h
  • +4 -4
    libpurple/media/backend-iface.h
    • --- 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.
    */