talkatu/talkatu

Fill out some missing documentation to get our coverage back to 100%

2020-08-26, Gary Kramlich
9c929229e8f9
Parents bde456446ed7
Children 132882e70996
Fill out some missing documentation to get our coverage back to 100%

Bring the docs up to 100% coverage.

Testing Done:
built the docs verified that `build/talkatu/reference/talkatu-undocumented.txt` has 100% coverage. Also ran the unit tests and demo to make sure nothing inadvertantly got busted.

Reviewed at https://reviews.imfreedom.org/r/91/
6 files changed, 50 insertions(+), 5 deletions(-)
  • +1 -0
    talkatu/reference/talkatu-docs.xml
  • +22 -0
    talkatu/talkatuattachment.c
  • +23 -1
    talkatu/talkatuinput.c
  • +1 -1
    talkatu/talkatuscrolledwindow.c
  • +2 -2
    talkatu/talkatusimpleattachment.c
  • +1 -1
    talkatu/talkatutypinglabel.c
    • --- a/talkatu/reference/talkatu-docs.xml Sat Aug 22 22:14:27 2020 -0500
    +++ b/talkatu/reference/talkatu-docs.xml Wed Aug 26 03:15:40 2020 -0500
    @@ -59,6 +59,7 @@
    <xi:include href="xml/talkatuattachment.xml"/>
    <xi:include href="xml/talkatuattachmentdialog.xml"/>
    <xi:include href="xml/talkatuattachmentpreview.xml"/>
    + <xi:include href="xml/talkatusimpleattachment.xml"/>
    <xi:include href="xml/talkatucore.xml"/>
    <xi:include href="xml/talkatucodeset.xml"/>
    --- a/talkatu/talkatuattachment.c Sat Aug 22 22:14:27 2020 -0500
    +++ b/talkatu/talkatuattachment.c Wed Aug 26 03:15:40 2020 -0500
    @@ -43,6 +43,28 @@
    * contents.
    */
    +/**
    + * TalkatuAttachmentInterface:
    + * @get_hash_key: A function that returns the key to hash the attachment with.
    + * This is typically just a pointer to the internal id variable,
    + * which is necessary due to the differences in 64-bit integers
    + * across platforms.
    + *
    + * #TalkatuAttachmentInterface defines the methods and behaviors that make up a
    + * #TalkatuAttachment. This was made an interface so clients can represent
    + * their data however they want but still provide a common interface for Talkatu
    + * to work with.
    + */
    +
    +/**
    + * TalkatuAttachmentForeachFunc:
    + * @attachment: A #TalkatuAttachment instance.
    + * @data: Caller supplied data.
    + *
    + * #TalkatuAttachmentForeachFunc is a callback function called against each
    + * #TalkatuAttachment in a collection.
    + */
    +
    G_DEFINE_INTERFACE(TalkatuAttachment, talkatu_attachment, G_TYPE_INVALID);
    /******************************************************************************
    --- a/talkatu/talkatuinput.c Sat Aug 22 22:14:27 2020 -0500
    +++ b/talkatu/talkatuinput.c Wed Aug 26 03:15:40 2020 -0500
    @@ -45,6 +45,20 @@
    */
    /**
    + * TalkatuInput:
    + *
    + * #TalkatuInput is the main input widget for Talkatu. It supports WYSIWYG
    + * input for both HTML and Markdown as well as plain text.
    + *
    + * It implements #TalkatuMessage which means it can be written directly to
    + * #TalkatuHistory with talkatu_history_write_message(). That also means that
    + * it can handle attachments. Currently this is only supported programatically.
    + *
    + * It provides keybinds for pasting images as well as emitting a signal when the
    + * user has pressed a developer defined keybinding to "send" the message.
    + */
    +
    +/**
    * TalkatuInputClass:
    * @should_send_message: The class handler for the
    * #TalkatuInput::should_send_message signal.
    @@ -782,9 +796,17 @@
    /******************************************************************************
    * Public API
    *****************************************************************************/
    +
    +/**
    + * talkatu_input_new:
    + *
    + * Creates a new #TalkatuInput instance.
    + *
    + * Returns: (transfer full): The new #TalkatuInput instance.
    + */
    GtkWidget *
    talkatu_input_new(void) {
    - return NULL;
    + return GTK_WIDGET(g_object_new(TALKATU_TYPE_INPUT, NULL));
    }
    /**
    --- a/talkatu/talkatuscrolledwindow.c Sat Aug 22 22:14:27 2020 -0500
    +++ b/talkatu/talkatuscrolledwindow.c Wed Aug 26 03:15:40 2020 -0500
    @@ -176,7 +176,7 @@
    }
    /**
    - * talkatu_scrolled_window__page_down:
    + * talkatu_scrolled_window_page_down:
    * @sw: The #TalkatuScrolledWindow instance.
    *
    * Scrolls @sw down one page.
    --- a/talkatu/talkatusimpleattachment.c Sat Aug 22 22:14:27 2020 -0500
    +++ b/talkatu/talkatusimpleattachment.c Wed Aug 26 03:15:40 2020 -0500
    @@ -26,8 +26,8 @@
    * @Short_description: A Simple Message Attachment
    *
    * #TalkatuSimpleAttachment is simple implementation of the #TalkatuAttachment
    - * interface. This is the easiest way to create a #TalkatuAction and attach it
    - * to a #TalkatuMessage.
    + * interface. This is the easiest way to create a #TalkatuAttachment and attach
    + * it to a #TalkatuMessage.
    */
    /**
    --- a/talkatu/talkatutypinglabel.c Sat Aug 22 22:14:27 2020 -0500
    +++ b/talkatu/talkatutypinglabel.c Wed Aug 26 03:15:40 2020 -0500
    @@ -264,7 +264,7 @@
    }
    /**
    - * talkatu_type_label_finish_typing:
    + * talkatu_typing_label_finish_typing:
    * @label: The #TalkatuTypingLabel instance.
    * @who: The caller defined user that has finished typing.
    *