libpurple/purpleprotocolclient.h

changeset 42656
df9aafbae930
parent 42615
2f3308794a8f
child 42685
88440894952c
--- a/libpurple/purpleprotocolclient.h	Wed Apr 03 16:32:56 2024 -0500
+++ b/libpurple/purpleprotocolclient.h	Tue Apr 09 21:50:31 2024 -0500
@@ -51,71 +51,6 @@
  * Since: 3.0
  */
 
-/**
- * PurpleProtocolClientInterface:
- * @get_actions: Returns the actions the protocol can perform. These will show
- *               up in the Accounts menu, under a submenu with the name of the
- *               account.
- * @list_emblem: Fills the four <type>char**</type>'s with string identifiers
- *               for "emblems" that the UI will interpret and display as
- *               relevant.
- * @blist_node_menu: Returns a list of #PurpleActionMenu structs, which
- *                   represent extra actions to be shown in (for example) the
- *                   right-click menu for @node.
- * @buddy_free: Allows the protocol to clean up any additional data for the
- *              given buddy.
- * @convo_closed: Allows the protocol to do any necessary cleanup when a
- *                conversation is closed.
- * @normalize: Convert the username @who to its canonical form. Also checks for
- *             validity.
- *             <sbr/>For example, AIM treats "fOo BaR" and "foobar" as the same
- *             user; this function should return the same normalized string for
- *             both of those. On the other hand, both of these are invalid for
- *             protocols with number-based usernames, so function should return
- *             %NULL in such case.
- *             <sbr/>@account: The account the username is related to. Can be
- *                             %NULL.
- *             <sbr/>@who:     The username to convert.
- *             <sbr/>Returns:  Normalized username, or %NULL, if it's invalid.
- * @find_blist_chat: Attempts to find a chat with the given name in the contact
- *                   list.
- * @offline_message: Checks whether offline messages to @buddy are supported.
- *                   <sbr/>Returns: %TRUE if @buddy can be sent messages while
- *                                  they are offline, or %FALSE if not.
- * @get_account_text_table: This allows protocols to specify additional strings
- *                          to be used for various purposes. The idea is to
- *                          stuff a bunch of strings in this hash table instead
- *                          of expanding the struct for every addition. This
- *                          hash table is allocated every call and
- *                          <emphasis>MUST</emphasis> be unrefed by the caller.
- *                          <sbr/>@account: The account to specify.  This can be
- *                                          %NULL.
- *                          <sbr/>Returns:  The protocol's string hash table.
- *                                          The hash table should be destroyed
- *                                          by the caller when it's no longer
- *                                          needed.
- * @get_max_message_size: Gets the maximum message size in bytes for the
- *                        conversation.
- *                        <sbr/>It may depend on connection-specific or
- *                        conversation-specific variables, like channel or
- *                        buddy's name length.
- *                        <sbr/>This value is intended for plaintext message,
- *                              the exact value may be lower because of:
- *                        <sbr/> - used newlines (some protocols count them as
- *                                 more than one byte),
- *                        <sbr/> - formatting,
- *                        <sbr/> - used special characters.
- *                        <sbr/>@conv:   The conversation to query, or NULL to
- *                                       get safe minimum for the protocol.
- *                        <sbr/>Returns: Maximum message size, 0 if unspecified,
- *                                       -1 for infinite.
- *
- * The protocol client interface.
- *
- * This interface provides a gateway between purple and the protocol.
- *
- * Since: 3.0
- */
 struct _PurpleProtocolClientInterface {
 	/*< private >*/
 	GTypeInterface parent;

mercurial