Migrate to gi-docgen and remove the doc comments that were gtk-doc specific
Testing Done:
Build the docs locally and via the convey plan.
Reviewed at https://reviews.imfreedom.org/r/1056/
--- a/.hgignore Mon Oct 18 01:44:07 2021 -0500
+++ b/.hgignore Mon Oct 18 02:40:39 2021 -0500
@@ -19,3 +19,5 @@
--- a/convey.yml Mon Oct 18 01:44:07 2021 -0500
+++ b/convey.yml Mon Oct 18 02:40:39 2021 -0500
@@ -41,10 +41,10 @@
- - ninja -C build-docs talkatu-doc
+ - ninja -C build-docs doc - files: build-docs/talkatu/reference/html:talkatu-docs
+ files: build-docs/talkatu/reference/talkatu:talkatu-docs --- a/meson.build Mon Oct 18 01:44:07 2021 -0500
+++ b/meson.build Mon Oct 18 02:40:39 2021 -0500
@@ -2,15 +2,15 @@
###############################################################################
project('talkatu', 'c', version : '0.1.0-dev',
- license : 'GPL-2.0-or-later',
- meson_version : '>=0.56.0',
- default_options : ['c_std=c99'])
+ license : 'GPL-2.0-or-later', + meson_version : '>=0.56.0', + default_options : ['c_std=c99']) parts = meson.project_version().split('-')
parts = parts[0].split('.')
@@ -61,6 +61,22 @@
###############################################################################
+############################################################################### +if get_option('doc') and not get_option('introspection') + error('Documentation requires GObject Introspection.') +gidocgen_dep = dependency( + 'gi-docgen', version: '>= 2021.1', + fallback: ['gi-docgen', 'dummy_dep'], + required: get_option('doc') +gidocgen = find_program('gi-docgen', required : get_option('doc')) +docs_dir = get_option('prefix') / get_option('datadir') / 'doc' +############################################################################### ###############################################################################
compiler = meson.get_compiler('c')
@@ -106,6 +122,15 @@
###############################################################################
+############################################################################### + doc_targets = [talkatu_doc] + alias_target('doc', doc_targets) +############################################################################### ###############################################################################
if meson.version().version_compare('>=0.58.0')
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/subprojects/gi-docgen.wrap Mon Oct 18 02:40:39 2021 -0500
@@ -0,0 +1,6 @@
+url=https://gitlab.gnome.org/GNOME/gi-docgen.git +push-url=ssh://git@gitlab.gnome.org:GNOME/gi-docgen.git --- a/talkatu/meson.build Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/meson.build Mon Oct 18 02:40:39 2021 -0500
@@ -214,12 +214,15 @@
sources : TALKATU_SOURCES + TALKATU_HEADERS +
TALKATU_PUBLIC_BUILT_SOURCES +
TALKATU_PUBLIC_BUILT_HEADERS,
+ export_packages : ['talkatu'], + extra_args : ['--quiet', '--warn-all', '-DTALKATU_COMPILATION'], + header : 'talkatu/talkatu.h', includes : ['GModule-2.0', 'GObject-2.0', 'Gtk-3.0'],
+ nsversion : '@0@.0'.format(TALKATU_MAJOR_VERSION), symbol_prefix : 'talkatu',
- nsversion : '@0@.0'.format(TALKATU_MAJOR_VERSION),
- extra_args : ['--quiet', '--warn-all', '-DTALKATU_COMPILATION'],
TALKATU_GENERATED_TARGETS += talkatu_gir
@@ -250,8 +253,5 @@
###############################################################################
--- a/talkatu/reference/Dockerfile Mon Oct 18 01:44:07 2021 -0500
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,6 +0,0 @@
--- a/talkatu/reference/meson.build Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/reference/meson.build Mon Oct 18 02:40:39 2021 -0500
@@ -1,40 +1,32 @@
+talkatu_doc_content_files = [] -# Header files or dirs to ignore when scanning. Use base file/dir names
-ignore_hfiles += TALKATU_PRIVATE_HEADERS
-# Extra options to supply to gtkdoc-scan.
- '--ignore-headers=' + ' '.join(ignore_hfiles),
+ talkatu_toml = configure_file( + input : 'talkatu.toml.in', + output : 'talkatu.toml', + configuration : version_conf, + install_dir : docs_dir / 'talkatu', -# Extra options to supply to gtkdoc-mkdb.
- '--ignore-files=' + ' '.join(ignore_hfiles),
-talkatu_version_xml = configure_file(
- input : 'version.xml.in',
- output : 'version.xml',
- configuration : version_conf)
+ talkatu_doc = custom_target('talkatu-doc', + input : [ talkatu_toml, talkatu_gir[0] ], + '--output-dir=@OUTPUT@', + '--content-dir=@0@'.format(meson.current_source_dir()), + depend_files : [ talkatu_doc_content_files ], + build_by_default : true, + install_dir : docs_dir,
-gnome.gtkdoc(DOC_MODULE,
- main_xml : DOC_MODULE + '-docs.xml',
- dependencies : talkatu_dep,
- gobject_typesfile : DOC_MODULE + '.types',
- content_files : content_files,
--- a/talkatu/reference/talkatu-docs.xml Mon Oct 18 01:44:07 2021 -0500
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,83 +0,0 @@
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
-<!ENTITY version SYSTEM "version.xml">
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
- <title>Talkatu Reference Manual</title>
- <title>Talkatu &version;</title>
- Talkatu is a collection of Gtk+ widgets that are useful for
- communication applications like Pidgin.
- <part id="object-hierarchy">
- <title>Object Hierarchy</title>
- <xi:include href="xml/tree_index.sgml"/>
- <title>API Reference</title>
- <xi:include href="xml/talkatuactiongroup.xml"/>
- <xi:include href="xml/talkatutag.xml"/>
- <xi:include href="xml/talkatutagtable.xml"/>
- <xi:include href="xml/talkatubuffer.xml"/>
- <xi:include href="xml/talkatuhtmlbuffer.xml"/>
- <xi:include href="xml/talkatumarkdownbuffer.xml"/>
- <xi:include href="xml/talkatuwholebuffer.xml"/>
- <xi:include href="xml/talkatumarkup.xml"/>
- <xi:include href="xml/talkatuhistory.xml"/>
- <xi:include href="xml/talkatuhistoryrow.xml"/>
- <xi:include href="xml/talkatuhtmlrenderer.xml"/>
- <xi:include href="xml/talkatuhtmlpangorenderer.xml"/>
- <xi:include href="xml/talkatuinput.xml"/>
- <xi:include href="xml/talkatueditor.xml"/>
- <xi:include href="xml/talkatuview.xml"/>
- <xi:include href="xml/talkatumessage.xml"/>
- <xi:include href="xml/talkatumessageactions.xml"/>
- <xi:include href="xml/talkatutoolbar.xml"/>
- <xi:include href="xml/talkatutooldrawer.xml"/>
- <xi:include href="xml/talkatumenutoolbutton.xml"/>
- <xi:include href="xml/talkatuscrolledwindow.xml"/>
- <xi:include href="xml/talkatutypinglabel.xml"/>
- <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"/>
- <xi:include href="xml/talkatuversion.xml"/>
- <xi:include href="xml/talkatulinkdialog.xml"/>
- <index id="api-index-full">
- <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
- <index id="api-index-deprecated" role="deprecated">
- <title>Index of deprecated symbols</title>
- <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
- <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/talkatu/reference/talkatu.toml.in Mon Oct 18 02:40:39 2021 -0500
@@ -0,0 +1,48 @@
+version = "@TALKATU_VERSION@" +browse_url = "https://keep.imfreedom.org/talkatu/talkatu/" +repository_url = "https://keep.imfreedom.org/talkatu/talkatu/" +website_url = "https://keep.imfreedom.org/talkatu/talkatu/" +authors = "Talkatu Developers" +license = "LGPL-2.1-or-later" +description = "Talkatu Plugin Library" +dependencies = [ "GLib-2.0", "GObject-2.0", "GModule-2.0", "Gtk-3.0" ] + [dependencies."GLib-2.0"] + description = "General-purpose, portable utility library." + docs_url = "https://docs.gtk.org/glib/" + [dependencies."GObject-2.0"] + description = "The base type system library" + docs_url = "https://docs.gtk.org/gobject/" + [dependencies."GModule-2.0"] + description = "Portable API for dynamically loading modules" + docs_url = "https://docs.gtk.org/gmodule/" + [dependencies."Gtk-3.0"] + description = "The GTK toolkit" + docs_url = "https://docs.gtk.org/gtk3/" +show_index_summary = true +show_class_hierarchy = true +base_url = "https://keep.imfreedom.org/talkatu/talkatu/file/default/" +# The same order will be used when generating the index +urlmap_file = "urlmap.js" --- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/talkatu/reference/urlmap.js Mon Oct 18 02:40:39 2021 -0500
@@ -0,0 +1,10 @@
+// SPDX-FileCopyrightText: 2021 GNOME Foundation +// SPDX-License-Identifier: LGPL-2.1-or-later +// A map between namespaces and base URLs for their online documentation + [ 'GLib', 'https://docs.gtk.org/glib/' ], + [ 'GObject', 'https://docs.gtk.org/gobject/' ], + [ 'GModule', 'https://docs.gtk.org/gmodule/' ], + [ 'Gtk', 'https://docs.gtk.org/gtk3/' ], --- a/talkatu/reference/version.xml.in Mon Oct 18 01:44:07 2021 -0500
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,2 +0,0 @@
--- a/talkatu/talkatuactiongroup.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatuactiongroup.c Mon Oct 18 02:40:39 2021 -0500
@@ -29,21 +29,6 @@
#include "talkatu/talkatutag.h"
- * SECTION:talkatuactiongroup
- * @Title: Talkatu Actions
- * @Short_description: GAction Helpers
- * A lot of Talkatu's user interaction is handled by #GAction's. These
- * functions help make that easier.
- * TALKATU_TYPE_ACTION_GROUP:
- * The standard _get_type macro for #TalkatuActionGroup.
* A #GSimpleActionGroup subclass that contains all of the actions for
--- a/talkatu/talkatuattachment.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatuattachment.c Mon Oct 18 02:40:39 2021 -0500
@@ -21,21 +21,6 @@
#include <glib/gi18n-lib.h>
- * SECTION:talkatuattachment
- * @Short_description: Message Attachments
- * Attachments can be images, files, etc that can be attached to a
- * TALKATU_TYPE_ATTACHMENT:
- * The standard _get_type macro for #TalkatuAttachment.
* TalkatuAttachment represents an attached file. The files can be any type of
--- a/talkatu/talkatuattachmentdialog.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatuattachmentdialog.c Mon Oct 18 02:40:39 2021 -0500
@@ -21,20 +21,6 @@
#include "talkatu/talkatuattachmentdialog.h"
- * SECTION:talkatuattachmentdialog
- * @Title: Attachment Dialog
- * @Short_description: A GtkDialog for sending message attachments.
- * A #GtkDialog that allows the user to customize attachments for a message.
- * TALKATU_TYPE_ATTACHMENT_DIALOG:
- * The standard _get_type macro for #TalkatuAttachmentDialog.
* TalkatuAttachmentDialog:
* A #GtkDialog that allows the user to customize an image message.
--- a/talkatu/talkatuattachmentpreview.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatuattachmentpreview.c Mon Oct 18 02:40:39 2021 -0500
@@ -21,20 +21,6 @@
#include "talkatu/talkatuattachmentpreview.h"
- * SECTION:talkatuattachmentpreview
- * @Title: Attachment Preview
- * @Short_description: Previews for TalkatuAttachments.
- * A simple widget that displays a preview of a #TalkatuAttachment.
- * TALKATU_TYPE_ATTACHMENT_PREVIEW:
- * The standard _get_type macro for #TalkatuAttachmentPreview.
* TalkatuAttachmentPreview:
* A #GtkWidget that displays a preview of a #TalkatuAttachment and allows the
--- a/talkatu/talkatubuffer.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatubuffer.c Mon Oct 18 02:40:39 2021 -0500
@@ -26,22 +26,6 @@
#include <talkatu/talkatutagtable.h>
- * SECTION:talkatubuffer
- * @Short_description: Common behavior for Talkatu text buffers.
- * Talkatu implements a couple of different types of text buffers. This API
- * tries to abstract the commonalities between them and make it easier to
- * create text buffers for additional markup types.
- * The standard _get_type macro for #TalkatuBuffer.
* A #GtkTextBuffer subclass that will automatically apply formatting according
--- a/talkatu/talkatucodeset.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatucodeset.c Mon Oct 18 02:40:39 2021 -0500
@@ -18,15 +18,6 @@
#include "talkatu/talkatucodeset.h"
- * SECTION:talkatucodeset
- * @Title: Codeset Helpers
- * @Short_description: Helpers for handling different codesets.
- * Dealing with user supplied input means handling different codesets and this
/******************************************************************************
*****************************************************************************/
--- a/talkatu/talkatucore.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatucore.c Mon Oct 18 02:40:39 2021 -0500
@@ -20,14 +20,6 @@
#include "talkatu/talkatucore.h"
- * @Short_description: Core API
- * The core API of Talkatu.
/******************************************************************************
*****************************************************************************/
--- a/talkatu/talkatueditor.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatueditor.c Mon Oct 18 02:40:39 2021 -0500
@@ -25,21 +25,6 @@
#include <talkatu/talkatutoolbar.h>
- * SECTION:talkatueditor
- * @Short_description: A simple editor composed of other Talkatu Widgets
- * TalkatuEditor is a composite widget of #TalkatuToolbar and #TalkatuView to
- * help make them easier to use.
- * The standard _get_type macro for #TalkatuEditor.
* A composite widget that contains a #TalkatuToolbar, #TalkatuInput, and an
--- a/talkatu/talkatuhistory.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatuhistory.c Mon Oct 18 02:40:39 2021 -0500
@@ -25,21 +25,6 @@
#include <talkatu/talkatumessage.h>
- * SECTION:talkatuhistory
- * @Short_description: Chat history widget
- * This widget is used to display the conversation history. It doesn't care if
- * 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/talkatuhistoryrow.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatuhistoryrow.c Mon Oct 18 02:40:39 2021 -0500
@@ -25,20 +25,6 @@
#include <talkatu/talkatuhtmlrenderer.h>
- * SECTION:talkatuhistoryrow
- * @Short_description: History message widget
- * This widget is used to display a single message in the conversation history.
- * TALKATU_TYPE_HISTORY_ROW:
- * The standard _get_type macro for #TalkatuHistoryRow.
* A #GtkListBoxRow subclass that is used to display a #TalkatuMessage.
--- a/talkatu/talkatuhtmlbuffer.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatuhtmlbuffer.c Mon Oct 18 02:40:39 2021 -0500
@@ -25,21 +25,6 @@
#include "talkatu/talkatutagtable.h"
- * SECTION:talkatuhtmlbuffer
- * @Short_description: HTML support
- * Support for HTML is provided via a custom GtkTextBuffer that knows how
- * to render it properly.
- * TALKATU_TYPE_HTML_BUFFER:
- * The standard _get_type macro for #TalkatuHtmlBuffer.
* A #TalkatuBuffer subclass that renders HTML.
--- a/talkatu/talkatuhtmlrenderer.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatuhtmlrenderer.c Mon Oct 18 02:40:39 2021 -0500
@@ -21,22 +21,6 @@
#include "talkatuhtmlrenderer.h"
- * SECTION:talkatuhtmlrenderer
- * @Title: HTML Renderer
- * @Short_description: An Expat-like HTML Renderer
- * #TalkatuHtmlRenderer is an abstract class that will parse HTML and call the
- * registered instance methods for each element allowing subclasses to render
- * the HTML however they like.
- * TALKATU_TYPE_HTML_RENDERER:
- * The standard _get_type macro for #TalkatuHtmlRenderer.
* TalkatuHtmlRendererClass:
* @reset: The method to call to reset the renderer. This allows the renderer
--- a/talkatu/talkatuinput.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatuinput.c Mon Oct 18 02:40:39 2021 -0500
@@ -32,20 +32,6 @@
#include "talkatu/talkatusimpleattachment.h"
- * @Short_description: The main Talkatu input widget.
- * #TalkatuInput handles all of the details for sending messages.
- * The standard _get_type macro for #TalkatuInput.
* #TalkatuInput is the main input widget for Talkatu. It supports WYSIWYG
--- a/talkatu/talkatulinkdialog.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatulinkdialog.c Mon Oct 18 02:40:39 2021 -0500
@@ -21,20 +21,6 @@
#include "talkatu/talkatulinkdialog.h"
- * SECTION:talkatulinkdialog
- * @Short_description: A GtkDialog for creating a link.
- * 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.
--- a/talkatu/talkatumarkdownbuffer.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatumarkdownbuffer.c Mon Oct 18 02:40:39 2021 -0500
@@ -26,21 +26,6 @@
#include "talkatu/talkatutagtable.h"
- * SECTION:talkatumarkdownbuffer
- * @Title: Markdown Buffer
- * @Short_description: Markdown support
- * Support for Markdown is provided via a custom GtkTextBuffer that knows how
- * to render it properly.
- * TALKATU_TYPE_MARKDOWN_BUFFER:
- * The standard _get_type macro for #TalkatuMarkdownBuffer.
* A #TalkatuBuffer subclass that renders markdown.
--- a/talkatu/talkatumarkup.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatumarkup.c Mon Oct 18 02:40:39 2021 -0500
@@ -22,15 +22,6 @@
#include <talkatu/talkatumarkup.h>
#include <talkatu/talkatutag.h>
- * SECTION:talkatumarkup
- * @Title: Markup Helpers
- * @Short_description: Helpers for reading/writing markup to GtkTextBuffers.
- * This API provides the ability to serialize and deserialize mark to/from
/******************************************************************************
*****************************************************************************/
--- a/talkatu/talkatumenutoolbutton.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatumenutoolbutton.c Mon Oct 18 02:40:39 2021 -0500
@@ -21,21 +21,6 @@
#include "talkatu/talkatumenutoolbutton.h"
- * SECTION:talkatumenutoolbutton
- * @Title: Menu Tool Button
- * @Short_description: A simple menu tool button.
- * The normal #GtkMenuToolButton forces you to have an action on the always
- * visible button. This #GtkToolItem instead just uses a label with no action.
- * TALKATU_TYPE_MENU_TOOL_BUTTON:
- * The standard _get_type macro for #TalkatuMenuToolButton.
* A #GtkToolButton subclass that behaves like a #GtkComboBox.
--- a/talkatu/talkatumessage.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatumessage.c Mon Oct 18 02:40:39 2021 -0500
@@ -22,21 +22,6 @@
#include "talkatu/talkatuenums.h"
- * SECTION:talkatumessage
- * @Short_description: A message representation
- * Talkatu needs a way to represent a message in a client agnostic way, this is
- * the API that does that.
- * TALKATU_TYPE_MESSAGE:
- * The standard _get_type macro for #TalkatuMessage.
* #TalkatuMessage is an opaque data structure and can only be accessed using
--- a/talkatu/talkatumessageactions.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatumessageactions.c Mon Oct 18 02:40:39 2021 -0500
@@ -21,21 +21,6 @@
#include "talkatu/talkatumessageactions.h"
- * SECTION:talkatumessageactions
- * @Title: Message actions
- * @Short_description: A display widget for #TalkatuMessage's
- * Talkatu provides a simple formatting message_actions that gives the user the ability
- * to format any #TalkatuBuffer via the formatting actions.
- * TALKATU_TYPE_MESSAGE_ACTIONS:
- * The standard _get_type macro for #TalkatuMessageActions.
* A composite #GtkWidget to allow the user to interact with a message in a
--- a/talkatu/talkatuscrolledwindow.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatuscrolledwindow.c Mon Oct 18 02:40:39 2021 -0500
@@ -21,26 +21,11 @@
#include <talkatu/talkatuscrolledwindow.h>
- * SECTION:talkatuscrolledwindow
- * @Title: Enhanced Scrolled Window
- * @Short_description: An enhanced GtkScrolledWindow
+ * TalkatuScrolledWindow: * This widget is a simple subclass of #GtkScrolledWindow that has helpers for
- * keyboard navigation as well as the ability to automatically scroll to the end
- * when new items are added if the widget was already scrolled all the way to
- * TALKATU_TYPE_SCROLLED_WINDOW:
- * The standard _get_type macro for #TalkatuScrolledWindow.
- * TalkatuScrolledWindow:
- * An enhanced #GtkScrolledWindow subclass.
+ * keyboard navigation as well as the ability to automatically scroll to the + * bottom when new items are added if the widget was already scrolled all the struct _TalkatuScrolledWindow {
GtkScrolledWindow parent;
--- a/talkatu/talkatusimpleattachment.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatusimpleattachment.c Mon Oct 18 02:40:39 2021 -0500
@@ -21,26 +21,11 @@
#include <glib/gi18n-lib.h>
- * SECTION:talkatusimpleattachment
- * @Title: Simple Attachments
- * @Short_description: A Simple Message Attachment
+ * TalkatuSimpleAttachment: * #TalkatuSimpleAttachment is simple implementation of the #TalkatuAttachment
- * interface. This is the easiest way to create a #TalkatuAttachment and attach
- * it to a #TalkatuMessage.
- * TALKATU_TYPE_SIMPLE_ATTACHMENT:
- * The standard _get_type macro for #TalkatuSimpleAttachment.
- * TalkatuSimpleAttachment:
- * TalkatuSimpleAttachment is an opaque data structure and can not be used
+ * interface. This is the easiest way to create a #TalkatuAttachment and + * attach it to a #TalkatuMessage. struct _TalkatuSimpleAttachment {
--- a/talkatu/talkatutag.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatutag.c Mon Oct 18 02:40:39 2021 -0500
@@ -21,20 +21,6 @@
#include "talkatu/talkatuenums.h"
- * @Short_description: Helpers for handling tags.
- * Talkatu deals with a lot of tags which this API tries to make easier.
- * The standard _get_type macro for #TalkatuTag.
* A constant that represents an anchor or link font style.
--- a/talkatu/talkatutagtable.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatutagtable.c Mon Oct 18 02:40:39 2021 -0500
@@ -25,21 +25,6 @@
#include <talkatu/talkatutagtable.h>
- * SECTION:talkatutagtable
- * @Short_description: A simple formatting tag_table
- * Talkatu provides a simple formatting tag_table that gives the user the ability
- * 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.
--- a/talkatu/talkatutoolbar.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatutoolbar.c Mon Oct 18 02:40:39 2021 -0500
@@ -21,21 +21,6 @@
#include "talkatu/talkatutoolbar.h"
- * SECTION:talkatutoolbar
- * @Short_description: A simple formatting toolbar
- * Talkatu provides a simple formatting toolbar that gives the user the ability
- * 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
--- a/talkatu/talkatutooldrawer.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatutooldrawer.c Mon Oct 18 02:40:39 2021 -0500
@@ -21,22 +21,6 @@
#include "talkatu/talkatutooldrawer.h"
#include "talkatu/talkatumenutoolbutton.h"
- * SECTION:talkatutooldrawer
- * @Title: ToolDrawer Tool Item
- * @Short_description: A GtkToolItem that can be expand to show multiple items.
- * A #TalkatuToolDrawer is a #GtkToolItem that groups many #GtkToolItems into a
- * collection that can be collapsed into a single item to eliminate clutter in
- * TALKATU_TYPE_TOOL_DRAWER:
- * The standard _get_type macro for #TalkatuToolDrawer.
--- a/talkatu/talkatutypinglabel.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatutypinglabel.c Mon Oct 18 02:40:39 2021 -0500
@@ -24,9 +24,7 @@
#include <talkatu/talkatutypinglabel.h>
- * SECTION:talkatutypinglabel
- * @Short_description: A GtkLabel that displays who's typing
* This widget implements a simple interface for displaying who is currently
* typing. You can call talkatu_typing_label_start_typing() whenever you
@@ -39,18 +37,6 @@
* Usernames are passed in as strings and their default display can be
* overridden by connecting to the #TalkatuTypingLabel::changed signal.
- * TALKATU_TYPE_TYPING_LABEL:
- * The standard _get_type macro for #TalkatuTypingLabel.
- * A #GtkLabel subclass that keeps track of who's typing.
--- a/talkatu/talkatuview.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatuview.c Mon Oct 18 02:40:39 2021 -0500
@@ -31,21 +31,6 @@
#include "talkatu/talkatuview.h"
- * @Short_description: Widget that displays a TalkatuBuffer
- * #TalkatuView handles the display of a #TalkatuBuffer, the keybindings for
- * applying formats, as well as displaying links.
- * The standard _get_type macro for #TalkatuView.
* @format_activate: The class handler for the #TalkatuView::format_activate
--- a/talkatu/talkatuwholebuffer.c Mon Oct 18 01:44:07 2021 -0500
+++ b/talkatu/talkatuwholebuffer.c Mon Oct 18 02:40:39 2021 -0500
@@ -22,21 +22,6 @@
#include "talkatu/talkatuwholebuffer.h"
- * SECTION:talkatuwholebuffer
- * @Short_description: A whole format text buffer
- * 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