qulogic/talkatu

A bunch more doc cleanups

2019-07-19, Gary Kramlich
481426bc3b02
Parents 7db80e8fd44e
Children 8da1a131a03b
A bunch more doc cleanups
12 files changed, 37 insertions(+), 2 deletions(-)
  • +5 -0
    talkatu/talkatuactiongroup.c
  • +3 -0
    talkatu/talkatuactiongroup.h
  • +6 -0
    talkatu/talkatubuffer.c
  • +3 -0
    talkatu/talkatubuffer.h
  • +5 -0
    talkatu/talkatuhistorybuffer.c
  • +3 -0
    talkatu/talkatuhistorybuffer.h
  • +5 -0
    talkatu/talkatuhtmlbuffer.c
  • +3 -0
    talkatu/talkatuhtmlbuffer.h
  • +0 -1
    talkatu/talkatumarkdownbuffer.c
  • +2 -0
    talkatu/talkatumarkdownbuffer.h
  • +0 -1
    talkatu/talkatuview.c
  • +2 -0
    talkatu/talkatuview.h
    • --- a/talkatu/talkatuactiongroup.c Fri Jul 19 07:34:08 2019 -0500
    +++ b/talkatu/talkatuactiongroup.c Fri Jul 19 08:01:13 2019 -0500
    @@ -32,6 +32,11 @@
    */
    /**
    + * TalkatuActionGroupClass:
    + * @action_activated: The class handler for the #TalkatuActionGroup::action-activated signal.
    + */
    +
    +/**
    * TALKATU_ACTION_FORMAT_BOLD:
    *
    * A constant that represents the bold font style action.
    --- a/talkatu/talkatuactiongroup.h Fri Jul 19 07:34:08 2019 -0500
    +++ b/talkatu/talkatuactiongroup.h Fri Jul 19 08:01:13 2019 -0500
    @@ -43,10 +43,13 @@
    G_DECLARE_DERIVABLE_TYPE(TalkatuActionGroup, talkatu_action_group, TALKATU, ACTION_GROUP, GSimpleActionGroup)
    struct _TalkatuActionGroupClass {
    + /*< private >*/
    GSimpleActionGroupClass parent;
    + /*< public >*/
    void (*action_activated)(TalkatuActionGroup *ag, GAction *action, const gchar *name);
    + /*< private >*/
    gpointer reserved[4];
    };
    --- a/talkatu/talkatubuffer.c Fri Jul 19 07:34:08 2019 -0500
    +++ b/talkatu/talkatubuffer.c Fri Jul 19 08:01:13 2019 -0500
    @@ -35,6 +35,12 @@
    */
    /**
    + * TalkatuBufferClass:
    + * @insert_markup: The insert_markup vfunc is called to insert already rendered text into the #TalkatuBuffer.
    + * @create_action_group: The create_action_group vfunc is called to get a #GSimpleAction group of actions that the #TalkatuBuffer supports.
    + */
    +
    +/**
    * TALKATU_BUFFER_LINK_TARGET_ATTRIBUTE:
    *
    * The name of the attribute set on #GtkTextTags that contain the URL for
    --- a/talkatu/talkatubuffer.h Fri Jul 19 07:34:08 2019 -0500
    +++ b/talkatu/talkatubuffer.h Fri Jul 19 08:01:13 2019 -0500
    @@ -40,12 +40,15 @@
    G_DECLARE_DERIVABLE_TYPE(TalkatuBuffer, talkatu_buffer, TALKATU, BUFFER, GtkTextBuffer)
    struct _TalkatuBufferClass {
    + /*< private >*/
    GtkTextBufferClass parent;
    + /*< public >*/
    void (*insert_markup)(TalkatuBuffer *buffer, GtkTextIter *pos, const gchar *new_text, gint new_text_length);
    GSimpleActionGroup *(*create_action_group)(TalkatuBuffer *buffer);
    + /*< private >*/
    gpointer reserved[4];
    };
    --- a/talkatu/talkatuhistorybuffer.c Fri Jul 19 07:34:08 2019 -0500
    +++ b/talkatu/talkatuhistorybuffer.c Fri Jul 19 08:01:13 2019 -0500
    @@ -31,6 +31,11 @@
    * manually.
    */
    +/**
    + * TalkatuHistoryBufferClass:
    + * @write_message: The write_message vfunc is called to render a #TalkatuMessage into the #TalkatuHistoryBuffer.
    + */
    +
    G_DEFINE_TYPE(TalkatuHistoryBuffer, talkatu_history_buffer, GTK_TYPE_TEXT_BUFFER);
    /******************************************************************************
    --- a/talkatu/talkatuhistorybuffer.h Fri Jul 19 07:34:08 2019 -0500
    +++ b/talkatu/talkatuhistorybuffer.h Fri Jul 19 08:01:13 2019 -0500
    @@ -35,10 +35,13 @@
    G_DECLARE_DERIVABLE_TYPE(TalkatuHistoryBuffer, talkatu_history_buffer, TALKATU, HISTORY_BUFFER, GtkTextBuffer)
    struct _TalkatuHistoryBufferClass {
    + /*< private >*/
    GtkTextBufferClass parent;
    + /*< public >*/
    void (*write_message)(TalkatuHistoryBuffer *buffer, TalkatuMessage *message);
    + /*< private >*/
    gpointer reserved[4];
    };
    --- a/talkatu/talkatuhtmlbuffer.c Fri Jul 19 07:34:08 2019 -0500
    +++ b/talkatu/talkatuhtmlbuffer.c Fri Jul 19 08:01:13 2019 -0500
    @@ -33,6 +33,11 @@
    * to render it properly.
    */
    +/**
    + * TalkatuHtmlBufferClass:
    + * @insert_html: The insert_html vfunc is called to render HTML into the #TalkatuHtmlBuffer.
    + */
    +
    G_DEFINE_TYPE(TalkatuHtmlBuffer, talkatu_html_buffer, TALKATU_TYPE_BUFFER);
    /******************************************************************************
    --- a/talkatu/talkatuhtmlbuffer.h Fri Jul 19 07:34:08 2019 -0500
    +++ b/talkatu/talkatuhtmlbuffer.h Fri Jul 19 08:01:13 2019 -0500
    @@ -37,10 +37,13 @@
    G_DECLARE_DERIVABLE_TYPE(TalkatuHtmlBuffer, talkatu_html_buffer, TALKATU, HTML_BUFFER, TalkatuBuffer)
    struct _TalkatuHtmlBufferClass {
    + /*< private >*/
    TalkatuBufferClass parent;
    + /*< public >*/
    void (*insert_html)(TalkatuHtmlBuffer *buffer, GtkTextIter *iter, const gchar *text, gint len);
    + /*< private >*/
    gpointer reserved[4];
    };
    --- a/talkatu/talkatumarkdownbuffer.c Fri Jul 19 07:34:08 2019 -0500
    +++ b/talkatu/talkatumarkdownbuffer.c Fri Jul 19 08:01:13 2019 -0500
    @@ -36,7 +36,6 @@
    /**
    * TalkatuMarkdownBufferClass:
    - * @parent: The object class structure needs to be the first.
    * @insert_markdown: The insert_markdown vfunc is called to render markdown into the #TalkatuMarkdownBuffer.
    */
    --- a/talkatu/talkatumarkdownbuffer.h Fri Jul 19 07:34:08 2019 -0500
    +++ b/talkatu/talkatumarkdownbuffer.h Fri Jul 19 08:01:13 2019 -0500
    @@ -37,8 +37,10 @@
    G_DECLARE_DERIVABLE_TYPE(TalkatuMarkdownBuffer, talkatu_markdown_buffer, TALKATU, MARKDOWN_BUFFER, TalkatuBuffer)
    struct _TalkatuMarkdownBufferClass {
    + /*< private >*/
    TalkatuBufferClass parent;
    + /*< public >*/
    void (*insert_markdown)(TalkatuMarkdownBuffer *buffer, GtkTextIter *iter, const gchar *text, gint len);
    /*< private >*/
    --- a/talkatu/talkatuview.c Fri Jul 19 07:34:08 2019 -0500
    +++ b/talkatu/talkatuview.c Fri Jul 19 08:01:13 2019 -0500
    @@ -39,7 +39,6 @@
    /**
    * TalkatuViewClass:
    - * @parent: The object class structure needs to be the first.
    * @format_activate: The class handler for the #TalkatuView::format_activate signal.
    * @should_send_message: The class handler for the #TalkatuView::should_send_message signal.
    * @send_message: The class handler for the #TalkatuView::send_message signal.
    --- a/talkatu/talkatuview.h Fri Jul 19 07:34:08 2019 -0500
    +++ b/talkatu/talkatuview.h Fri Jul 19 08:01:13 2019 -0500
    @@ -43,8 +43,10 @@
    G_DECLARE_DERIVABLE_TYPE(TalkatuView, talkatu_view, TALKATU, VIEW, GtkTextView)
    struct _TalkatuViewClass {
    + /*< private >*/
    GtkTextViewClass parent;
    + /*< public >*/
    void (*format_activate)(TalkatuView *view, const gchar *action_name);
    void (*should_send_message)(TalkatuView *view, TalkatuViewSendBinding binding);