Merged in default (pull request #31)
Fix up the docs to get to 100% coverage
Approved-by: Elliott Sales de Andrade
--- a/talkatu/talkatuactiongroup.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatuactiongroup.c Mon Jul 22 07:32:37 2019 +0000
@@ -32,6 +32,28 @@
+ * TALKATU_TYPE_ACTION_GROUP: + * The standard _get_type macro for #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. * TALKATU_ACTION_FORMAT_BOLD:
* A constant that represents the bold font style action.
--- a/talkatu/talkatuactiongroup.h Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatuactiongroup.h Mon Jul 22 07:32:37 2019 +0000
@@ -43,10 +43,13 @@
G_DECLARE_DERIVABLE_TYPE(TalkatuActionGroup, talkatu_action_group, TALKATU, ACTION_GROUP, GSimpleActionGroup)
struct _TalkatuActionGroupClass {
GSimpleActionGroupClass parent;
void (*action_activated)(TalkatuActionGroup *ag, GAction *action, const gchar *name);
--- a/talkatu/talkatubuffer.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatubuffer.c Mon Jul 22 07:32:37 2019 +0000
@@ -35,6 +35,30 @@
+ * The standard _get_type macro for #TalkatuBuffer. + * A #GtkTextBuffer subclass that will automatically apply formatting according + * to the actions in a #GSimpleAction group. + * @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. * TALKATU_BUFFER_LINK_TARGET_ATTRIBUTE:
* The name of the attribute set on #GtkTextTags that contain the URL for
@@ -669,4 +693,4 @@
gtk_text_buffer_get_bounds(GTK_TEXT_BUFFER(buffer), &start, &end);
return gtk_text_iter_equal(&start, &end);
\ No newline at end of file
--- a/talkatu/talkatubuffer.h Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatubuffer.h Mon Jul 22 07:32:37 2019 +0000
@@ -40,12 +40,15 @@
G_DECLARE_DERIVABLE_TYPE(TalkatuBuffer, talkatu_buffer, TALKATU, BUFFER, GtkTextBuffer)
struct _TalkatuBufferClass {
GtkTextBufferClass parent;
void (*insert_markup)(TalkatuBuffer *buffer, GtkTextIter *pos, const gchar *new_text, gint new_text_length);
GSimpleActionGroup *(*create_action_group)(TalkatuBuffer *buffer);
--- a/talkatu/talkatueditor.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatueditor.c Mon Jul 22 07:32:37 2019 +0000
@@ -31,6 +31,18 @@
* help make them easier to use.
+ * The standard _get_type macro for #TalkatuEditor. + * A composite widget that contains a #TalkatuToolbar, #TalkatuView, and an + * optional send button in the common instant messaging input layout. --- a/talkatu/talkatuhistory.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatuhistory.c Mon Jul 22 07:32:37 2019 +0000
@@ -30,6 +30,17 @@
* it is multi user or one to one.
+ * TALKATU_TYPE_HISTORY: + * The standard _get_type macro for #TalkatuHistory. + * A #TalkatuView subclass that is used to display a conversation. --- a/talkatu/talkatuhistorybuffer.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatuhistorybuffer.c Mon Jul 22 07:32:37 2019 +0000
@@ -31,6 +31,27 @@
+ * TALKATU_TYPE_HISTORY_BUFFER: + * The standard _get_type macro for #TalkatuHistoryBuffer. + * TalkatuHistoryBuffer: + * A #TalkatuBuffer subclass that works on #TalkatuMessage's rather than raw + * 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/talkatuhistorybuffer.h Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatuhistorybuffer.h Mon Jul 22 07:32:37 2019 +0000
@@ -35,10 +35,13 @@
G_DECLARE_DERIVABLE_TYPE(TalkatuHistoryBuffer, talkatu_history_buffer, TALKATU, HISTORY_BUFFER, GtkTextBuffer)
struct _TalkatuHistoryBufferClass {
GtkTextBufferClass parent;
void (*write_message)(TalkatuHistoryBuffer *buffer, TalkatuMessage *message);
--- a/talkatu/talkatuhtmlbuffer.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatuhtmlbuffer.c Mon Jul 22 07:32:37 2019 +0000
@@ -33,6 +33,26 @@
+ * TALKATU_TYPE_HTML_BUFFER: + * The standard _get_type macro for #TalkatuHtmlBuffer. + * A #TalkatuBuffer subclass that renders HTML. + * TalkatuHtmlBufferClass: + * @insert_html: The insert_html vfunc is called to render HTML into the + * The backing class to #TalkatuHtmlBuffer. G_DEFINE_TYPE(TalkatuHtmlBuffer, talkatu_html_buffer, TALKATU_TYPE_BUFFER);
/******************************************************************************
--- a/talkatu/talkatuhtmlbuffer.h Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatuhtmlbuffer.h Mon Jul 22 07:32:37 2019 +0000
@@ -37,10 +37,13 @@
G_DECLARE_DERIVABLE_TYPE(TalkatuHtmlBuffer, talkatu_html_buffer, TALKATU, HTML_BUFFER, TalkatuBuffer)
struct _TalkatuHtmlBufferClass {
TalkatuBufferClass parent;
void (*insert_html)(TalkatuHtmlBuffer *buffer, GtkTextIter *iter, const gchar *text, gint len);
--- a/talkatu/talkatulinkdialog.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatulinkdialog.c Mon Jul 22 07:32:37 2019 +0000
@@ -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. + * A simple #GtkDialog subclass to allow the user to create a link. struct _TalkatuLinkDialog {
--- a/talkatu/talkatumarkdownbuffer.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatumarkdownbuffer.c Mon Jul 22 07:32:37 2019 +0000
@@ -34,6 +34,26 @@
+ * 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"
G_DEFINE_TYPE(TalkatuMarkdownBuffer, talkatu_markdown_buffer, TALKATU_TYPE_BUFFER);
--- a/talkatu/talkatumarkdownbuffer.h Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatumarkdownbuffer.h Mon Jul 22 07:32:37 2019 +0000
@@ -37,14 +37,14 @@
G_DECLARE_DERIVABLE_TYPE(TalkatuMarkdownBuffer, talkatu_markdown_buffer, TALKATU, MARKDOWN_BUFFER, TalkatuBuffer)
struct _TalkatuMarkdownBufferClass {
TalkatuBufferClass parent;
void (*insert_markdown)(TalkatuMarkdownBuffer *buffer, GtkTextIter *iter, const gchar *text, gint len);
- void (*_talkatu_reserved1)(void);
- void (*_talkatu_reserved2)(void);
- void (*_talkatu_reserved3)(void);
- void (*_talkatu_reserved4)(void);
GtkTextBuffer *talkatu_markdown_buffer_new(void);
--- a/talkatu/talkatumenutoolbutton.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatumenutoolbutton.c Mon Jul 22 07:32:37 2019 +0000
@@ -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 {
--- a/talkatu/talkatumessage.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatumessage.c Mon Jul 22 07:32:37 2019 +0000
@@ -30,6 +30,27 @@
+ * TALKATU_TYPE_MESSAGE: + * The standard _get_type macro for #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. * @TALKATU_CONTENT_TYPE_PLAIN: Plain text content.
* @TALKATU_CONTENT_TYPE_PANGO: Pango Markup content.
--- a/talkatu/talkatumessageactions.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatumessageactions.c Mon Jul 22 07:32:37 2019 +0000
@@ -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 struct _TalkatuMessageActions {
--- a/talkatu/talkatutag.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatutag.c Mon Jul 22 07:32:37 2019 +0000
@@ -29,15 +29,21 @@
- * The prefix that all talkatu tags use.
+ * The standard _get_type macro for #TalkatuTag. - * TALKATU_TAG_PREFIX_LEN:
- * The length of #TALKATU_TAG_PREFIX for easy computation.
+ * A constant that represents an anchor or link font style. + * A constant for referencing the styling for an author. @@ -47,63 +53,48 @@
- * 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.
- * A constant that represents a pre formatted font style.
* A constant that represents a code font style.
+ * TALKATU_TAG_CONTENTS: + * A constant for the tag that tags message contents in a #TalkatuHistory
- * A constant that represents the highlighed search term font style.
+ * A constant that represents the dd HTML element.
+ * A constant that represents the dl HTML element. - * 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. @@ -142,6 +133,87 @@
* A constant that represents the h6 header font style.
+ * A constant that represents the italic font style. + * A constant for the tag that tags an entire message in a #TalkatuHistory + * A constant that represents a preformatted font style. + * The prefix that all Talkatu tags use. + * TALKATU_TAG_PREFIX_LEN: + * The length of #TALKATU_TAG_PREFIX for easy computation. + * A constant that represents the highlighted search term font style. + * TALKATU_TAG_STRIKETHROUGH: + * A constant that represents the strikethrough 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. + * @TALKATU_TAG_DISPLAY_INLINE: The tag should be rendered inline. + * @TALKATU_TAG_DISPLAY_BLOCK: The tag should be rendered on its own line. + * An enum representing how a tag should be rendered. + * TalkatuTag is a #GtkTextTag subclass that has a few additional properties + * that allows greater control of how text is rendered. @@ -218,7 +290,9 @@
* @name: The name to give the tag.
- * @...: Pairs of property names and values terminated by NULL.
+ * @first_property: The name of the first property to set. + * @...: The value of the first property followed optionally by more name/value + * pairs, followed by NULL. * Creates a new #TalkatuTag to be used for styling text.
@@ -324,6 +398,14 @@
+ * talkatu_tag_get_display: + * @tag: The #TalkatuTag instance. + * Gets the #TalkatuTagDisplay for @tag. + * Returns: The #TalkatuTagDisplay for @tag. talkatu_tag_get_display(TalkatuTag *tag) {
g_return_val_if_fail(TALKATU_IS_TAG(tag), TALKATU_TAG_DISPLAY_INLINE);
@@ -331,6 +413,13 @@
+ * talkatu_tag_set_display: + * @tag: The #TalkatuTag instance. + * @display: The #TalkatuTagDisplay value to set. + * Sets the display type for @tag to @display. talkatu_tag_set_display(TalkatuTag *tag, TalkatuTagDisplay display) {
g_return_if_fail(TALKATU_IS_TAG(tag));
--- a/talkatu/talkatutagtable.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatutagtable.c Mon Jul 22 07:32:37 2019 +0000
@@ -32,6 +32,17 @@
* to format any #TalkatuBuffer via the formatting actions.
+ * TALKATU_TYPE_TAG_TABLE: + * The standard _get_type macro for #TalkatuTagTable. + * A #GtkTextTagTable subclass that is preloaded with all of the #TalkatuTag's. struct _TalkatuTagTable {
--- a/talkatu/talkatutoolbar.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatutoolbar.c Mon Jul 22 07:32:37 2019 +0000
@@ -28,6 +28,19 @@
* to format any #TalkatuBuffer via the formatting actions.
+ * TALKATU_TYPE_TOOLBAR: + * The standard _get_type macro for #TalkatuToolbar. + * The formatting toolbar for #TalkatuView's. It's based on the + * #GSimpleActionGroup's that #TalkatuBuffer's expose which makes it completely --- a/talkatu/talkatutooldrawer.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatutooldrawer.c Mon Jul 22 07:32:37 2019 +0000
@@ -31,6 +31,12 @@
+ * TALKATU_TYPE_TOOL_DRAWER: + * The standard _get_type macro for #TalkatuToolDrawer. @@ -39,7 +45,17 @@
+ * A #GtkToolItem subclass that displays a menu of items or can be expanded + * to show all of the items as a toolbar. struct _TalkatuToolDrawer {
--- a/talkatu/talkatuview.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatuview.c Mon Jul 22 07:32:37 2019 +0000
@@ -38,9 +38,27 @@
+ * The standard _get_type macro for #TalkatuView. + * @format_activate: The class handler for the #TalkatuView::format_activate + * @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. * TalkatuViewSendBinding:
- * @TALKATU_VIEW_SEND_BINDING_RETURN: Represents the return.
- * @TALKATU_VIEW_SEND_BINDING_KP_ENTER: Represents the enter.
+ * @TALKATU_VIEW_SEND_BINDING_RETURN: Represents return. + * @TALKATU_VIEW_SEND_BINDING_KP_ENTER: Represents enter. * @TALKATU_VIEW_SEND_BINDING_SHIFT_RETURN: Represents shift-return.
* @TALKATU_VIEW_SEND_BINDING_CONTROL_RETURN: Represents control-return.
@@ -48,6 +66,12 @@
+ * A #GtkTextView subclass that's preconfigured with a #TalkatuBuffer. GSimpleActionGroup *action_group;
TalkatuViewSendBinding send_binding;
--- a/talkatu/talkatuview.h Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatuview.h Mon Jul 22 07:32:37 2019 +0000
@@ -43,8 +43,10 @@
G_DECLARE_DERIVABLE_TYPE(TalkatuView, talkatu_view, TALKATU, VIEW, GtkTextView)
struct _TalkatuViewClass {
void (*format_activate)(TalkatuView *view, const gchar *action_name);
void (*should_send_message)(TalkatuView *view, TalkatuViewSendBinding binding);
@@ -52,7 +54,8 @@
void (*open_url)(TalkatuView *view, const gchar *url);
GtkWidget *talkatu_view_new(void);
--- a/talkatu/talkatuwholebuffer.c Fri Jul 19 21:36:09 2019 +0000
+++ b/talkatu/talkatuwholebuffer.c Mon Jul 22 07:32:37 2019 +0000
@@ -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. + * A #TalkatuBuffer subclass that applies formatting to the entire buffer + * rather that allowing rich formatting at character resolution. struct _TalkatuWholeBuffer {