qulogic/talkatu

Finish fixing all of the docs

2019-07-19, Gary Kramlich
8da1a131a03b
Parents 481426bc3b02
Children 4b987b9f6c7b
Finish fixing all of the docs
17 files changed, 325 insertions(+), 49 deletions(-)
  • +16 -0
    talkatu/talkatuactiongroup.c
  • +15 -0
    talkatu/talkatubuffer.c
  • +12 -0
    talkatu/talkatueditor.c
  • +11 -0
    talkatu/talkatuhistory.c
  • +15 -0
    talkatu/talkatuhistorybuffer.c
  • +14 -0
    talkatu/talkatuhtmlbuffer.c
  • +11 -0
    talkatu/talkatulinkdialog.c
  • +14 -0
    talkatu/talkatumarkdownbuffer.c
  • +12 -0
    talkatu/talkatumenutoolbutton.c
  • +13 -0
    talkatu/talkatumessage.c
  • +12 -0
    talkatu/talkatumessageactions.c
  • +113 -49
    talkatu/talkatutag.c
  • +11 -0
    talkatu/talkatutagtable.c
  • +13 -0
    talkatu/talkatutoolbar.c
  • +16 -0
    talkatu/talkatutooldrawer.c
  • +14 -0
    talkatu/talkatuview.c
  • +13 -0
    talkatu/talkatuwholebuffer.c
    • --- a/talkatu/talkatuactiongroup.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatuactiongroup.c Fri Jul 19 09:02:01 2019 -0500
    @@ -32,8 +32,24 @@
    */
    /**
    + * TALKATU_TYPE_ACTION_GROUP:
    + *
    + * The standard _get_type macro for #TalkatuActionGroup.
    + */
    +
    +/**
    + * TalkatuActionGroup:
    + *
    + * A #GSimpleActionGroup subclass that contains all of the actions for
    + * formatting text in Talkatu. They are typically created by
    + * #TalkatuBuffer subclasses.
    + */
    +
    +/**
    * TalkatuActionGroupClass:
    * @action_activated: The class handler for the #TalkatuActionGroup::action-activated signal.
    + *
    + * The backing class of a #TalkatuActionGroup.
    */
    /**
    --- a/talkatu/talkatubuffer.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatubuffer.c Fri Jul 19 09:02:01 2019 -0500
    @@ -35,9 +35,24 @@
    */
    /**
    + * TALKATU_TYPE_BUFFER:
    + *
    + * The standard _get_type macro for #TalkatuBuffer.
    + */
    +
    +/**
    + * TalkatuBuffer:
    + *
    + * A #GtkTextBuffer subclass that will automatically apply formatting according
    + * to the actions in a #GSimpleAction group.
    + */
    +
    +/**
    * 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.
    + *
    + * The backing class to #TalkatuBuffer.
    */
    /**
    --- a/talkatu/talkatueditor.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatueditor.c Fri Jul 19 09:02:01 2019 -0500
    @@ -31,6 +31,18 @@
    * help make them easier to use.
    */
    +/**
    + * TALKATU_TYPE_EDITOR:
    + *
    + * The standard _get_type macro for #TalkatuEditor.
    + */
    +
    +/**
    + * TalkatuEditor:
    + *
    + * A composite widget that contains a #TalkatuToolbar, #TalkatuView, and an
    + * optional send button in the command instant messaging input layout.
    + */
    struct _TalkatuEditor {
    GtkBox parent;
    --- a/talkatu/talkatuhistory.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatuhistory.c Fri Jul 19 09:02:01 2019 -0500
    @@ -29,6 +29,17 @@
    * it is multi user or one to one.
    */
    +/**
    + * TALKATU_TYPE_HISTORY:
    + *
    + * The standard _get_type macro for #TalkatuHistory.
    + */
    +
    +/**
    + * TalkatuHistory:
    + *
    + * A #TalkatuView subclass that is used to display a conversation.
    + */
    struct _TalkatuHistory {
    TalkatuView parent;
    };
    --- a/talkatu/talkatuhistorybuffer.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatuhistorybuffer.c Fri Jul 19 09:02:01 2019 -0500
    @@ -32,8 +32,23 @@
    */
    /**
    + * TALKATU_TYPE_HISTORY_BUFFER:
    + *
    + * The standard _get_type macro for #TalkatuHistoryBuffer.
    + */
    +
    +/**
    + * TalkatuHistoryBuffer:
    + *
    + * A #TalkatuBuffer subclass that works on #TalkatuMessage's rather than raw
    + * text.
    + */
    +
    +/**
    * TalkatuHistoryBufferClass:
    * @write_message: The write_message vfunc is called to render a #TalkatuMessage into the #TalkatuHistoryBuffer.
    + *
    + * The backing class to #TalkatuHistoryBuffer.
    */
    G_DEFINE_TYPE(TalkatuHistoryBuffer, talkatu_history_buffer, GTK_TYPE_TEXT_BUFFER);
    --- a/talkatu/talkatuhtmlbuffer.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatuhtmlbuffer.c Fri Jul 19 09:02:01 2019 -0500
    @@ -34,8 +34,22 @@
    */
    /**
    + * TALKATU_TYPE_HTML_BUFFER:
    + *
    + * The standard _get_type macro for #TalkatuHtmlBuffer.
    + */
    +
    +/**
    + * TalkatuHtmlBuffer:
    + *
    + * A #TalkatuBuffer subclass that renders HTML.
    + */
    +
    +/**
    * TalkatuHtmlBufferClass:
    * @insert_html: The insert_html vfunc is called to render HTML into the #TalkatuHtmlBuffer.
    + *
    + * The backing class to #TalkatuHtmlBuffer.
    */
    G_DEFINE_TYPE(TalkatuHtmlBuffer, talkatu_html_buffer, TALKATU_TYPE_BUFFER);
    --- a/talkatu/talkatulinkdialog.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatulinkdialog.c Fri Jul 19 09:02:01 2019 -0500
    @@ -27,6 +27,17 @@
    * A simple dialog to aid in the creation of a link.
    */
    +/**
    + * TALKATU_TYPE_LINK_DIALOG:
    + *
    + * The standard _get_type macro for #TalkatuLinkDialog.
    + */
    +
    +/**
    + * TalkatuLinkDialog:
    + *
    + * A simple #GtkDialog subclass to allow the user to create a link.
    + */
    struct _TalkatuLinkDialog {
    GtkDialog parent;
    --- a/talkatu/talkatumarkdownbuffer.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatumarkdownbuffer.c Fri Jul 19 09:02:01 2019 -0500
    @@ -35,8 +35,22 @@
    */
    /**
    + * TALKATU_TYPE_MARKDOWN_BUFFER:
    + *
    + * The standard _get_type macro for #TalkatuMarkdownBuffer.
    + */
    +
    +/**
    + * TalkatuMarkdownBuffer:
    + *
    + * A #TalkatuBuffer subclass that renders markdown.
    + */
    +
    +/**
    * TalkatuMarkdownBufferClass:
    * @insert_markdown: The insert_markdown vfunc is called to render markdown into the #TalkatuMarkdownBuffer.
    + *
    + * The backing class for #TalkatuMarkdownBuffer.
    */
    #define TALKATU_MARKDOWN_LINK_TARGET_ATTRIBUTE "markdown_link_target"
    --- a/talkatu/talkatumenutoolbutton.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatumenutoolbutton.c Fri Jul 19 09:02:01 2019 -0500
    @@ -29,6 +29,18 @@
    * visible button. This #GtkToolItem instead just uses a label with no action.
    */
    +/**
    + * TALKATU_TYPE_MENU_TOOL_BUTTON:
    + *
    + * The standard _get_type macro for #TalkatuMenuToolButton.
    + */
    +
    +/**
    + * TalkatuMenuToolButton:
    + *
    + * A #GtkToolButton subclass that behaves like a #GtkComboBox.
    + */
    +
    struct _TalkatuMenuToolButton {
    GtkToolButton parent;
    --- a/talkatu/talkatumessage.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatumessage.c Fri Jul 19 09:02:01 2019 -0500
    @@ -30,8 +30,21 @@
    */
    /**
    + * TALKATU_TYPE_MESSAGE:
    + *
    + * The standard _get_type macro for #TalkatuMessage.
    + */
    +
    +/**
    * TalkatuMessage:
    *
    + * #TalkatuMessage is an opaque data structure and can only be accessed using
    + * the following functions.
    + */
    +
    +/**
    + * TalkatuMessageInterface:
    + *
    * #TalkatuMessage is an interface to be implemented to standardize the way
    * messages are handled. All of its properties should be overridden with a
    * sensible value returned for them.
    --- a/talkatu/talkatumessageactions.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatumessageactions.c Fri Jul 19 09:02:01 2019 -0500
    @@ -28,6 +28,18 @@
    * to format any #TalkatuBuffer via the formatting actions.
    */
    +/**
    + * TALKATU_TYPE_MESSAGE_ACTIONS:
    + *
    + * The standard _get_type macro for #TalkatuMessageActions.
    + */
    +
    +/**
    + * TalkatuMessageActions:
    + *
    + * A composite #GtkWidget to allow the user to interact with a message in a
    + * #TalkatuHistory.
    + */
    struct _TalkatuMessageActions {
    GtkBox parent;
    --- a/talkatu/talkatutag.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatutag.c Fri Jul 19 09:02:01 2019 -0500
    @@ -29,15 +29,21 @@
    */
    /**
    - * TALKATU_TAG_PREFIX:
    + * TALKATU_TYPE_TAG:
    *
    - * The prefix that all talkatu tags use.
    + * The standard _get_type macro for #TalkatuTag.
    */
    /**
    - * TALKATU_TAG_PREFIX_LEN:
    + * TALKATU_TAG_ANCHOR:
    *
    - * The length of #TALKATU_TAG_PREFIX for easy computation.
    + * A constant that represents an anchor or link font style.
    + */
    +
    +/**
    + * TALKATU_TAG_AUTHOR:
    + *
    + * A constant for referencing the styling for an author.
    */
    /**
    @@ -47,63 +53,48 @@
    */
    /**
    - * TALKATU_TAG_ITALIC:
    - *
    - * A constant that represents the italic font style.
    - */
    -
    -/**
    - * TALKATU_TAG_UNDERLINE:
    - *
    - * A constant that represents the underlined font style.
    - */
    -
    -
    -/**
    - * TALKATU_TAG_STRIKETHROUGH:
    - *
    - * A constant that represents the strike through font style.
    - */
    -
    -
    -/**
    - * TALKATU_TAG_SUBSCRIPT:
    - *
    - * A constant that represents the sub-script font style.
    - */
    -
    -
    -/**
    - * TALKATU_TAG_SUPERSCRIPT:
    - *
    - * A constant that represents the super-script font style.
    - */
    -
    -
    -/**
    - * TALKATU_TAG_PRE:
    - *
    - * A constant that represents a pre formatted font style.
    - */
    -
    -
    -/**
    * TALKATU_TAG_CODE:
    *
    * A constant that represents a code font style.
    */
    +/**
    + * TALKATU_TAG_CONTENTS:
    + *
    + * A constant for the tag that tags message contents in a #TalkatuHistory
    + * buffer.
    + */
    /**
    - * TALKATU_TAG_SEARCH:
    + * TALKATU_TAG_DD:
    *
    - * A constant that represents the highlighed search term font style.
    + * A constant that represents the dd HTML element.
    */
    /**
    - * TALKATU_TAG_ANCHOR:
    + * TALKATU_TAG_DL:
    + *
    + * A constant that represents the dl HTML element.
    + */
    +
    +/**
    + * TALKATU_TAG_DT:
    *
    - * A constant that represents an anchor or link font style.
    + * A constant that reprensents the dt HTML element.
    + */
    +
    +/**
    + * TALKATU_TAG_FORMATTING_END:
    + *
    + * A constant to be used as a suffix for tags that need formatting applied
    + * after the original tag.
    + */
    +
    +/**
    + * TALKATU_TAG_FORMATTING_START:
    + *
    + * A constant to be used as a prefix for tags that need formatting applied
    + * before the original tag.
    */
    /**
    @@ -143,6 +134,73 @@
    */
    /**
    + * TALKATU_TAG_ITALIC:
    + *
    + * A constant that represents the italic font style.
    + */
    +
    +/**
    + * TALKATU_TAG_MESSAGE:
    + *
    + * A constant for the tag that tags an entire message in a #TalkatuHistory
    + * buffer.
    + */
    +
    +/**
    + * TALKATU_TAG_PRE:
    + *
    + * A constant that represents a pre formatted font style.
    + */
    +
    +/**
    + * TALKATU_TAG_PREFIX:
    + *
    + * The prefix that all talkatu tags use.
    + */
    +
    +/**
    + * TALKATU_TAG_PREFIX_LEN:
    + *
    + * The length of #TALKATU_TAG_PREFIX for easy computation.
    + */
    +
    +/**
    + * TALKATU_TAG_SEARCH:
    + *
    + * A constant that represents the highlighed search term font style.
    + */
    +
    +/**
    + * TALKATU_TAG_STRIKETHROUGH:
    + *
    + * A constant that represents the strike through font style.
    + */
    +
    +/**
    + * TALKATU_TAG_SUBSCRIPT:
    + *
    + * A constant that represents the sub-script font style.
    + */
    +
    +/**
    + * TALKATU_TAG_SUPERSCRIPT:
    + *
    + * A constant that represents the super-script font style.
    + */
    +
    +/**
    + * TALKATU_TAG_TIMESTAMP:
    + *
    + * A constant that represents the timestamp font style.
    + */
    +
    +/**
    + * TALKATU_TAG_UNDERLINE:
    + *
    + * A constant that represents the underlined font style.
    + */
    +
    +/**
    * TalkatuTagDisplay:
    * @TALKATU_TAG_DISPLAY_INLINE: The tag should be rendered inline.
    * @TALKATU_TAG_DISPLAY_BLOCK: The tag should be rendered on it's own line.
    @@ -150,6 +208,12 @@
    * An enum representing how a tag should be rendered.
    */
    +/**
    + * TalkatuTag:
    + *
    + * TalkatuTag is a #GtkTextTag subclass that has a few additional properties
    + * that allows greater control of how text is rendered.
    + */
    struct _TalkatuTag {
    GtkTextTag parent;
    --- a/talkatu/talkatutagtable.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatutagtable.c Fri Jul 19 09:02:01 2019 -0500
    @@ -32,6 +32,17 @@
    * to format any #TalkatuBuffer via the formatting actions.
    */
    +/**
    + * TALKATU_TYPE_TAG_TABLE:
    + *
    + * The standard _get_type macro for #TalkatuTagTable.
    + */
    +
    +/**
    + * TalkatuTagTable:
    + *
    + * A #GtkTextTagTable subclass that is preloaded with all of the #TalkatuTag's.
    + */
    struct _TalkatuTagTable {
    GtkTextTagTable parent;
    };
    --- a/talkatu/talkatutoolbar.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatutoolbar.c Fri Jul 19 09:02:01 2019 -0500
    @@ -28,6 +28,19 @@
    * to format any #TalkatuBuffer via the formatting actions.
    */
    +/**
    + * TALKATU_TYPE_TOOLBAR:
    + *
    + * The standard _get_type macro for #TalkatuToolbar.
    + */
    +
    +/**
    + * TalkatuToolbar:
    + *
    + * The formatting toolbar for #TalkatuView's. It's based on the
    + * #GSimpleActionGroup's that #TalkatuBuffer's expose which makes it completely
    + * autonomous.
    + */
    struct _TalkatuToolbar {
    GtkToolbar parent;
    };
    --- a/talkatu/talkatutooldrawer.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatutooldrawer.c Fri Jul 19 09:02:01 2019 -0500
    @@ -31,6 +31,12 @@
    * the user interface.
    */
    +/**
    + * TALKATU_TYPE_TOOL_DRAWER:
    + *
    + * The standard _get_type macro for #TalkatuToolDrawer.
    + */
    +
    typedef struct {
    GAction *action;
    gchar *markup;
    @@ -39,7 +45,17 @@
    GCallback callback;
    } TalkatuToolDrawerItem;
    +/**
    + * TalkatuToolDrawer:
    + *
    + * A #GtkToolItem subclass that displays a menu of items or can be expanded
    + * to show all of the items as a toolbar.
    + *
    + * Stability: Unstable
    + */
    struct _TalkatuToolDrawer {
    + GtkToolItem parent;
    +
    gchar *label;
    gchar *icon_name;
    gboolean expanded;
    --- a/talkatu/talkatuview.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatuview.c Fri Jul 19 09:02:01 2019 -0500
    @@ -38,11 +38,19 @@
    */
    /**
    + * TALKATU_TYPE_VIEW:
    + *
    + * The standard _get_type macro for #TalkatuView.
    + */
    +
    +/**
    * TalkatuViewClass:
    * @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.
    * @open_url: The class handler for the #TalkatuView::open_url signal.
    + *
    + * The backing class to #TalkatuView instances.
    */
    /**
    @@ -56,6 +64,12 @@
    * send a message.
    */
    +/**
    + * TalkatuView:
    + *
    + * A #GtkTextView subclass that's preconfigured with a #TalkatuBuffer.
    + */
    +
    typedef struct {
    GSimpleActionGroup *action_group;
    TalkatuViewSendBinding send_binding;
    --- a/talkatu/talkatuwholebuffer.c Fri Jul 19 08:01:13 2019 -0500
    +++ b/talkatu/talkatuwholebuffer.c Fri Jul 19 09:02:01 2019 -0500
    @@ -28,6 +28,19 @@
    * TalkatuWholeBuffer is a #GtkTextBuffer who's formatting applied to the
    * entire buffer and not on a character by character basis.
    */
    +
    +/**
    + * TALKATU_TYPE_WHOLE_BUFFER:
    + *
    + * The standard _get_type macro for #TalkatuWholeBuffer.
    + */
    +
    +/**
    + * TalkatuWholeBuffer:
    + *
    + * A #TalkatuBuffer subclass that applies formatting to the entire buffer
    + * rather that allowing rich formatting at character resolution.
    + */
    struct _TalkatuWholeBuffer {
    TalkatuBuffer parent;
    };