qulogic/talkatu

Clean up docs for talkatutag.[ch]

2019-07-19, Gary Kramlich
a40e5c40b58d
Parents a9d9f03d1c64
Children a6a059aa7db5
Clean up docs for talkatutag.[ch]
1 files changed, 24 insertions(+), 0 deletions(-)
  • +24 -0
    talkatu/talkatutag.c
    • --- a/talkatu/talkatutag.c Fri Jul 19 02:31:11 2019 -0500
    +++ b/talkatu/talkatutag.c Fri Jul 19 07:15:18 2019 -0500
    @@ -142,6 +142,14 @@
    * A constant that represents the h6 header 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.
    + *
    + * An enum representing how a tag should be rendered.
    + */
    +
    struct _TalkatuTag {
    GtkTextTag parent;
    @@ -218,6 +226,7 @@
    /**
    * talkatu_tag_new:
    * @name: The name to give the tag.
    + * @first_property: The name of the first property to set.
    * @...: Pairs of property names and values terminated by NULL.
    *
    * Creates a new #TalkatuTag to be used for styling text.
    @@ -324,6 +333,14 @@
    return NULL;
    }
    +/**
    + * talkatu_tag_get_display:
    + * @tag: The #TalkatuTag instance.
    + *
    + * Gets the #TalkatuTagDisplay for @tag.
    + *
    + * Returns: The #TalkatuTagDisplay for @tag.
    + */
    TalkatuTagDisplay
    talkatu_tag_get_display(TalkatuTag *tag) {
    g_return_val_if_fail(TALKATU_IS_TAG(tag), TALKATU_TAG_DISPLAY_INLINE);
    @@ -331,6 +348,13 @@
    return tag->display;
    }
    +/**
    + * talkatu_tag_set_display:
    + * @tag: The #TalkatuTag instance.
    + * @display: The #TalkatuTagDisplay value to set.
    + *
    + * Sets the display type for @tag to @display.
    + */
    void
    talkatu_tag_set_display(TalkatuTag *tag, TalkatuTagDisplay display) {
    g_return_if_fail(TALKATU_IS_TAG(tag));