pidgin/pidgin

DOC: Set some element types to utf8.

2019-09-30, Elliott Sales de Andrade
1f924c6c4786
Parents 39d9e58389ee
Children 4fb59abd727e
DOC: Set some element types to utf8.

Seems more correct than general char*.
1 files changed, 15 insertions(+), 22 deletions(-)
  • +15 -22
    libpurple/conversationtypes.h
    • --- a/libpurple/conversationtypes.h Sun Sep 29 02:41:56 2019 -0400
    +++ b/libpurple/conversationtypes.h Mon Sep 30 23:48:55 2019 -0400
    @@ -377,13 +377,11 @@
    /**
    * purple_chat_conversation_set_ignored:
    * @chat: The chat.
    - * @ignored: (element-type char*):
    - * The list of ignored users.
    + * @ignored: (element-type utf8): The list of ignored users.
    *
    * Sets the list of ignored users in the chat room.
    *
    - * Returns: (element-type char*) (transfer none):
    - * The list passed.
    + * Returns: (element-type utf8) (transfer none): The list passed.
    */
    GList *purple_chat_conversation_set_ignored(PurpleChatConversation *chat, GList *ignored);
    @@ -393,8 +391,7 @@
    *
    * Returns the list of ignored users in the chat room.
    *
    - * Returns: (element-type char*) (transfer none):
    - * The list of ignored users.
    + * Returns: (element-type utf8) (transfer none): The list of ignored users.
    */
    GList *purple_chat_conversation_get_ignored(PurpleChatConversation *chat);
    @@ -494,20 +491,17 @@
    /**
    * purple_chat_conversation_add_users:
    - * @chat: The chat.
    - * @users: (element-type char*):
    - * The list of users to add.
    - * @extra_msgs: (element-type char*) (nullable):
    - * An extra message to display with the join message for each
    - * user. This list may be shorter than @users, in which
    - * case, the users after the end of extra_msgs will not have
    - * an extra message. By extension, this means that extra_msgs
    - * can simply be %NULL and none of the users will have an
    - * extra message.
    - * @flags: (element-type PurpleChatUserFlags):
    - * The list of flags for each user.
    - * This list data should be an int converted to pointer using
    - * GINT_TO_POINTER(flag)
    + * @chat: The chat.
    + * @users: (element-type utf8): The list of users to add.
    + * @extra_msgs: (element-type utf8) (nullable): An extra message to display
    + * with the join message for each user. This list may be shorter
    + * than @users, in which case, the users after the end of
    + * extra_msgs will not have an extra message. By extension, this
    + * means that extra_msgs can simply be %NULL and none of the users
    + * will have an extra message.
    + * @flags: (element-type PurpleChatUserFlags): The list of flags for each user.
    + * This list data should be an int converted to pointer using
    + * GINT_TO_POINTER(flag)
    * @new_arrivals: Decides whether or not to show join notices.
    *
    * Adds a list of users to a chat.
    @@ -545,8 +539,7 @@
    /**
    * purple_chat_conversation_remove_users:
    * @chat: The chat.
    - * @users: (element-type char*)
    - * The users that are being removed.
    + * @users: (element-type utf8): The users that are being removed.
    * @reason: The optional reason given for the removal. Can be %NULL.
    *
    * Removes a list of users from a chat, optionally with a single reason.