pidgin/pidgin

Clean up some random gtk-doc warnings in libpurple's documentation

2021-03-26, Gary Kramlich
ea25e596b1d4
Parents f3fd62f8c831
Children 4ee19005534e
Clean up some random gtk-doc warnings in libpurple's documentation

Testing Done:
Ran `ninja libpurple-doc` locally, verified the warnings went away.

Reviewed at https://reviews.imfreedom.org/r/585/
4 files changed, 35 insertions(+), 4 deletions(-)
  • +0 -3
    libpurple/conversation.h
  • +3 -0
    libpurple/eventloop.h
  • +18 -0
    libpurple/log.h
  • +14 -1
    libpurple/notify.h
    • --- a/libpurple/conversation.h Fri Mar 26 01:31:55 2021 -0500
    +++ b/libpurple/conversation.h Fri Mar 26 01:33:03 2021 -0500
    @@ -119,9 +119,6 @@
    /**************************************************************************/
    /**
    * PurpleConversation:
    - * @ui_data: The UI data associated with this conversation. This is a
    - * convenience field provided to the UIs -- it is not used by the
    - * libpurple core.
    *
    * A core representation of a conversation between two or more people.
    *
    --- a/libpurple/eventloop.h Fri Mar 26 01:31:55 2021 -0500
    +++ b/libpurple/eventloop.h Fri Mar 26 01:33:03 2021 -0500
    @@ -51,6 +51,9 @@
    /**
    * PurpleInputFunction:
    + * @data: User specified data.
    + * @fd: The input file descriptor.
    + * @cond: The condition type.
    *
    * The type of callbacks to handle events on file descriptors, as passed to
    * purple_input_add(). The callback will receive the @user_data passed to
    --- a/libpurple/log.h Fri Mar 26 01:31:55 2021 -0500
    +++ b/libpurple/log.h Fri Mar 26 01:33:03 2021 -0500
    @@ -46,12 +46,26 @@
    typedef struct _PurpleLogCommonLoggerData PurpleLogCommonLoggerData;
    typedef struct _PurpleLogSet PurpleLogSet;
    +/**
    + * PurpleLogType:
    + * @PURPLE_LOG_IM: Indicates an IM conversation.
    + * @PURPLE_LOG_CHAT: Indicates a chat.
    + * @PURPLE_LOG_SYSTEM: Indicates a server log.
    + *
    + * The individual types of logs.
    + */
    typedef enum {
    PURPLE_LOG_IM,
    PURPLE_LOG_CHAT,
    PURPLE_LOG_SYSTEM
    } PurpleLogType;
    +/**
    + * PurpleLogReadFlags:
    + * @PURPLE_LOG_READ_NO_NEWLINE: Defines that newlines should be ignored.
    + *
    + * Flags that should be used when reading a log.
    + */
    typedef enum {
    PURPLE_LOG_READ_NO_NEWLINE = 1
    } PurpleLogReadFlags;
    @@ -162,6 +176,9 @@
    /**
    * PurpleLogCommonLoggerData:
    + * @path: The path to the file.
    + * @file: The pointer to the open file handle.
    + * @extra_data: User supplied data.
    *
    * A common logger_data struct containing a file handle and path, as well
    * as a pointer to something else for additional data.
    @@ -556,6 +573,7 @@
    * <literal>create</literal>, %NULL (a placeholder for
    * <literal>write</literal>), and <literal>finalize</literal>
    * (for a total of 3 functions).
    + * @...: The functions used to log.
    *
    * Creates a new logger
    *
    --- a/libpurple/notify.h Fri Mar 26 01:31:55 2021 -0500
    +++ b/libpurple/notify.h Fri Mar 26 01:33:03 2021 -0500
    @@ -62,6 +62,7 @@
    /**
    * PurpleNotifyCloseCallback:
    + * @user_data: User specified data.
    *
    * Notification close callbacks.
    */
    @@ -114,8 +115,16 @@
    * PurpleNotifySearchButtonType:
    * @PURPLE_NOTIFY_BUTTON_LABELED: special use, see
    * purple_notify_searchresults_button_add_labeled()
    + * @PURPLE_NOTIFY_BUTTON_CONTINUE: A continue button.
    + * @PURPLE_NOTIFY_BUTTON_ADD: An add button.
    + * @PURPLE_NOTIFY_BUTTON_INFO: An info button.
    + * @PURPLE_NOTIFY_BUTTON_IM: An IM button.
    + * @PURPLE_NOTIFY_BUTTON_JOIN: A join button.
    + * @PURPLE_NOTIFY_BUTTON_INVITE: An invite button.
    *
    - * The types of buttons
    + * Constant values to define the type of buttons to use in a request dialog.
    + * These are used by user interfaces to label and possibly add an icon to the
    + * button.
    */
    typedef enum
    {
    @@ -147,6 +156,10 @@
    /**
    * PurpleNotifyUserInfoEntryType:
    + * @PURPLE_NOTIFY_USER_INFO_ENTRY_PAIR: A label and its value.
    + * @PURPLE_NOTIFY_USER_INFO_ENTRY_SECTION_BREAK: Separates two sections.
    + * @PURPLE_NOTIFY_USER_INFO_ENTRY_SECTION_HEADER: Create a header for the
    + * current section.
    *
    * Types of PurpleNotifyUserInfoEntry objects
    */