pidgin/pidgin

Remove unnecessary gtk-doc comments and move them where possible from libpurple/[a-c]*.h

2021-12-11, Gary Kramlich
92a47aa620cf
Parents 72afb5d62f12
Children 0df058800827
Remove unnecessary gtk-doc comments and move them where possible from libpurple/[a-c]*.h

Testing Done:
Compiled

Reviewed at https://reviews.imfreedom.org/r/1178/
15 files changed, 8 insertions(+), 111 deletions(-)
  • +8 -11
    libpurple/account.h
  • +0 -9
    libpurple/accounts.h
  • +0 -9
    libpurple/action.h
  • +0 -6
    libpurple/blistnode.h
  • +0 -7
    libpurple/buddy.h
  • +0 -7
    libpurple/buddyicon.h
  • +0 -8
    libpurple/buddylist.h
  • +0 -7
    libpurple/chat.h
  • +0 -6
    libpurple/circularbuffer.h
  • +0 -8
    libpurple/cmds.h
  • +0 -7
    libpurple/connection.h
  • +0 -6
    libpurple/contact.h
  • +0 -7
    libpurple/conversations.h
  • +0 -7
    libpurple/core.h
  • +0 -6
    libpurple/countingnode.h
    • --- a/libpurple/account.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/account.h Sat Dec 11 20:18:06 2021 -0600
    @@ -26,17 +26,6 @@
    #ifndef PURPLE_ACCOUNT_H
    #define PURPLE_ACCOUNT_H
    -/**
    - * SECTION:account
    - * @section_id: libpurple-account
    - * @short_description: <filename>account.h</filename>
    - * @title: Account Object
    - *
    - * A #PurpleAccount is the core configuration for connecting to a specific
    - * account. User interfaces typically allow users to create these in a dialog
    - * or wizard.
    - */
    -
    #include <glib.h>
    #include <glib-object.h>
    @@ -118,6 +107,14 @@
    /**************************************************************************/
    /**
    + * PurpleAccount:
    + *
    + * A #PurpleAccount is the core configuration for connecting to a specific
    + * account. User interfaces typically allow users to create these in a dialog
    + * or wizard.
    + */
    +
    +/**
    * purple_account_get_type:
    *
    * Returns: The #GType for the Account object.
    --- a/libpurple/accounts.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/accounts.h Sat Dec 11 20:18:06 2021 -0600
    @@ -25,15 +25,6 @@
    #ifndef PURPLE_ACCOUNTS_H
    #define PURPLE_ACCOUNTS_H
    -/**
    - * SECTION:accounts
    - * @section_id: libpurple-accounts
    - * @short_description: <filename>accounts.h</filename>
    - * @title: Accounts Subsystem API
    - * @see_also: <link linkend="chapter-signals-account">Account signals</link>
    - *
    - * The accounts API is used to help manage #PurpleAccount's.
    - */
    #include "account.h"
    #include "status.h"
    --- a/libpurple/action.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/action.h Sat Dec 11 20:18:06 2021 -0600
    @@ -29,15 +29,6 @@
    #include <glib.h>
    #include <glib-object.h>
    -/**
    - * SECTION:action
    - * @section_id: libpurple-action
    - * @short_description: <filename>action.h</filename>
    - * @title: Protocol Actions
    - *
    - * This API allows protocols to expose actions to a user interface.
    - */
    -
    #define PURPLE_TYPE_PROTOCOL_ACTION (purple_protocol_action_get_type())
    typedef struct _PurpleProtocolAction PurpleProtocolAction;
    --- a/libpurple/blistnode.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/blistnode.h Sat Dec 11 20:18:06 2021 -0600
    @@ -25,12 +25,6 @@
    #ifndef PURPLE_BLIST_NODE_H
    #define PURPLE_BLIST_NODE_H
    -/**
    - * SECTION:blistnode
    - * @section_id: libpurple-blistnode
    - * @short_description: <filename>blistnode.h</filename>
    - * @title: Buddy List Node and Counting Node types
    - */
    #include <glib.h>
    #include <glib-object.h>
    --- a/libpurple/buddy.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/buddy.h Sat Dec 11 20:18:06 2021 -0600
    @@ -26,13 +26,6 @@
    #ifndef PURPLE_BUDDY_H
    #define PURPLE_BUDDY_H
    -/**
    - * SECTION:buddy
    - * @section_id: libpurple-buddy
    - * @short_description: <filename>buddy.h</filename>
    - * @title: Buddy Object
    - */
    -
    #define PURPLE_TYPE_BUDDY (purple_buddy_get_type())
    #define PURPLE_BUDDY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_BUDDY, PurpleBuddy))
    #define PURPLE_BUDDY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_BUDDY, PurpleBuddyClass))
    --- a/libpurple/buddyicon.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/buddyicon.h Sat Dec 11 20:18:06 2021 -0600
    @@ -29,13 +29,6 @@
    #include <glib.h>
    #include <gio/gio.h>
    -/**
    - * SECTION:buddyicon
    - * @section_id: libpurple-buddyicon
    - * @short_description: <filename>buddyicon.h</filename>
    - * @title: Buddy Icon API
    - */
    -
    #define PURPLE_TYPE_BUDDY_ICON (purple_buddy_icon_get_type())
    /**
    --- a/libpurple/buddylist.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/buddylist.h Sat Dec 11 20:18:06 2021 -0600
    @@ -26,14 +26,6 @@
    #ifndef PURPLE_BUDDY_LIST_H
    #define PURPLE_BUDDY_LIST_H
    -/**
    - * SECTION:buddylist
    - * @section_id: libpurple-buddylist
    - * @short_description: <filename>buddylist.h</filename>
    - * @title: Buddy List API
    - * @see_also: <link linkend="chapter-signals-blist">Buddy List signals</link>
    - */
    -
    /* I can't believe I let ChipX86 inspire me to write good code. -Sean */
    #include "buddy.h"
    --- a/libpurple/chat.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/chat.h Sat Dec 11 20:18:06 2021 -0600
    @@ -26,13 +26,6 @@
    #ifndef PURPLE_CHAT_H
    #define PURPLE_CHAT_H
    -/**
    - * SECTION:chat
    - * @section_id: libpurple-chat
    - * @short_description: <filename>chat.h</filename>
    - * @title: Chat Object
    - */
    -
    #define PURPLE_TYPE_CHAT (purple_chat_get_type())
    #define PURPLE_CHAT(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_CHAT, PurpleChat))
    #define PURPLE_CHAT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_CHAT, PurpleChatClass))
    --- a/libpurple/circularbuffer.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/circularbuffer.h Sat Dec 11 20:18:06 2021 -0600
    @@ -23,12 +23,6 @@
    #ifndef PURPLE_CIRCULAR_BUFFER_H
    #define PURPLE_CIRCULAR_BUFFER_H
    -/**
    - * SECTION:circularbuffer
    - * @section_id: libpurple-circularbuffer
    - * @short_description: <filename>circularbuffer.h</filename>
    - * @title: Buffer Utility Functions
    - */
    #include <glib.h>
    #include <glib-object.h>
    --- a/libpurple/cmds.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/cmds.h Sat Dec 11 20:18:06 2021 -0600
    @@ -23,14 +23,6 @@
    #ifndef PURPLE_CMDS_H
    #define PURPLE_CMDS_H
    -/**
    - * SECTION:cmds
    - * @section_id: libpurple-cmds
    - * @short_description: <filename>cmds.h</filename>
    - * @title: Commands API
    - * @see_also: <link linkend="chapter-signals-cmd">Command signals</link>
    - */
    -
    #include <purpleconversation.h>
    /******************************************************************************
    --- a/libpurple/connection.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/connection.h Sat Dec 11 20:18:06 2021 -0600
    @@ -25,13 +25,6 @@
    #ifndef PURPLE_CONNECTION_H
    #define PURPLE_CONNECTION_H
    -/**
    - * SECTION:connection
    - * @section_id: libpurple-connection
    - * @short_description: <filename>connection.h</filename>
    - * @title: Connection API
    - * @see_also: <link linkend="chapter-signals-connection">Connection signals</link>
    - */
    #include <glib.h>
    --- a/libpurple/contact.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/contact.h Sat Dec 11 20:18:06 2021 -0600
    @@ -25,12 +25,6 @@
    #ifndef PURPLE_CONTACT_H
    #define PURPLE_CONTACT_H
    -/**
    - * SECTION:contact
    - * @section_id: libpurple-contact
    - * @short_description: <filename>contact.h</filename>
    - * @title: Contact Object
    - */
    #define PURPLE_TYPE_CONTACT (purple_contact_get_type())
    #define PURPLE_CONTACT(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_CONTACT, PurpleContact))
    --- a/libpurple/conversations.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/conversations.h Sat Dec 11 20:18:06 2021 -0600
    @@ -25,13 +25,6 @@
    #ifndef PURPLE_CONVERSATIONS_H
    #define PURPLE_CONVERSATIONS_H
    -/**
    - * SECTION:conversations
    - * @section_id: libpurple-conversations
    - * @short_description: <filename>conversations.h</filename>
    - * @title: Conversations Subsystem API
    - * @see_also: <link linkend="chapter-signals-conversation">Conversation signals</link>
    - */
    #include <purpleconversation.h>
    #include "server.h"
    --- a/libpurple/core.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/core.h Sat Dec 11 20:18:06 2021 -0600
    @@ -25,13 +25,6 @@
    #ifndef PURPLE_CORE_H
    #define PURPLE_CORE_H
    -/**
    - * SECTION:core
    - * @section_id: libpurple-core
    - * @short_description: <filename>core.h</filename>
    - * @title: Startup and Shutdown of libpurple
    - * @see_also: <link linkend="chapter-signals-core">Core signals</link>
    - */
    #include <glib.h>
    #include <glib-object.h>
    --- a/libpurple/countingnode.h Sat Dec 11 20:15:32 2021 -0600
    +++ b/libpurple/countingnode.h Sat Dec 11 20:18:06 2021 -0600
    @@ -25,12 +25,6 @@
    #ifndef PURPLE_COUNTING_NODE_H
    #define PURPLE_COUNTING_NODE_H
    -/**
    - * SECTION:countingnode
    - * @section_id: libpurple-countingnode
    - * @short_description: <filename>countingnode.h</filename>
    - * @title: CountingNode Object
    - */
    #include <glib.h>
    #include <glib-object.h>