Mercurial > pidgin3 / changeset

changeset

Convert finch to gi-docgen

Tue, 19 Oct 2021 00:48:05 -0500

author
Gary Kramlich <grim@reaperworld.com>
date
Tue, 19 Oct 2021 00:48:05 -0500
changeset 41123
089c8a3a9ff4
parent 41122
f29fa0dda4bf
child 41124
95555046173e

Convert finch to gi-docgen

Testing Done:
Ran the docs manually and in convey verfied that they look super!

Reviewed at https://reviews.imfreedom.org/r/1072/

convey.yaml file | annotate | diff | comparison | revisions
doc/reference/finch/finch-docs.xml file | annotate | diff | comparison | revisions
doc/reference/finch/finch.toml.in file | annotate | diff | comparison | revisions
doc/reference/finch/meson.build file | annotate | diff | comparison | revisions
doc/reference/finch/urlmap.js file | annotate | diff | comparison | revisions
doc/reference/finch/version.xml.in file | annotate | diff | comparison | revisions
finch/gntaccount.h file | annotate | diff | comparison | revisions
finch/gntblist.h file | annotate | diff | comparison | revisions
finch/gntconn.h file | annotate | diff | comparison | revisions
finch/gntconv.h file | annotate | diff | comparison | revisions
finch/gntdebug.h file | annotate | diff | comparison | revisions
finch/gntidle.h file | annotate | diff | comparison | revisions
finch/gntmedia.h file | annotate | diff | comparison | revisions
finch/gntmenuutil.h file | annotate | diff | comparison | revisions
finch/gntnotify.h file | annotate | diff | comparison | revisions
finch/gntplugin.h file | annotate | diff | comparison | revisions
finch/gntprefs.h file | annotate | diff | comparison | revisions
finch/gntrequest.h file | annotate | diff | comparison | revisions
finch/gntstatus.h file | annotate | diff | comparison | revisions
finch/gntui.h file | annotate | diff | comparison | revisions
finch/gntxfer.h file | annotate | diff | comparison | revisions
finch/libfinch.h file | annotate | diff | comparison | revisions
finch/meson.build file | annotate | diff | comparison | revisions 
--- a/convey.yaml	Tue Oct 19 00:47:42 2021 -0500
+++ b/convey.yaml	Tue Oct 19 00:48:05 2021 -0500
@@ -45,7 +45,7 @@
   docs-export:
     type: docker/export
     files:
-      - build-docs/doc/reference/finch/html/:finch3-docs
+      - build-docs/doc/reference/finch/finch/:finch3-docs
       - build-docs/doc/reference/libpurple/html/:purple3-docs
       - build-docs/doc/reference/pidgin/html/:pidgin3-docs
       - build-docs/doc/reference/protocols/facebook/facebook/:facebook3-docs
--- a/doc/reference/finch/finch-docs.xml	Tue Oct 19 00:47:42 2021 -0500
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,60 +0,0 @@
-<?xml version="1.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">
-  <bookinfo>
-    <title>Finch Reference Manual</title>
-    <abstract>
-      <title>Finch &version;</title>
-      <para>
-        GNT (GLib Ncurses Toolkit) is an ncurses toolkit for creating text-mode
-        graphical user interfaces in a fast and easy way.
-      </para>
-      <para>
-        Finch is a text-mode frontend to libpurple, built using libgnt.
-      </para>
-    </abstract>
-  </bookinfo>
-
-  <part id="finch">
-    <title>Finch API Reference</title>
-
-      <xi:include href="xml/gntaccount.xml" />
-      <xi:include href="xml/gntblist.xml" />
-      <xi:include href="xml/gntconn.xml" />
-      <xi:include href="xml/gntconv.xml" />
-      <xi:include href="xml/gntdebug.xml" />
-      <xi:include href="xml/gntxfer.xml" />
-      <xi:include href="xml/gntidle.xml" />
-      <xi:include href="xml/gntmedia.xml" />
-      <xi:include href="xml/gntmenuutil.xml" />
-      <xi:include href="xml/gntnotify.xml" />
-      <xi:include href="xml/gntplugin.xml" />
-      <xi:include href="xml/gntprefs.xml" />
-      <xi:include href="xml/gntrequest.xml" />
-      <xi:include href="xml/gntroomlist.xml" />
-      <xi:include href="xml/gntstatus.xml" />
-      <xi:include href="xml/gntui.xml" />
-      <xi:include href="xml/finch.xml" />
-  </part>
-
-  <part>
-    <title>Appendices</title>
-
-    <index id="api-index-full">
-      <title>API Index</title>
-      <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
-    </index>
-
-    <index id="api-deprecated">
-      <title>Index of deprecated symbols</title>
-      <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
-    </index>
-
-    <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
-  </part>
-</book>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/reference/finch/finch.toml.in	Tue Oct 19 00:48:05 2021 -0500
@@ -0,0 +1,48 @@
+[library]
+version = "@PURPLE_VERSION@"
+browse_url = "https://keep.imfreedom.org/pidgin/pidgin/"
+repository_url = "https://keep.imfreedom.org/pidgin/pidgin/"
+website_url = "https://keep.imfreedom.org/pidgin/pidgin/"
+authors = "Pidgin Developers"
+logo_url = ""
+license = "GPL-2.0-or-later"
+description = "Finch Universal Chat Client"
+dependencies = [ "GLib-2.0", "GObject-2.0", "GModule-2.0", "Gnt-3.0", "Purple-3.0" ]
+devhelp = true
+search_index = true
+
+  [dependencies."GLib-2.0"]
+  name = "GLib"
+  description = "General-purpose, portable utility library."
+  docs_url = "https://docs.gtk.org/glib/"
+
+  [dependencies."GObject-2.0"]
+  name = "GObject"
+  description = "The base type system library"
+  docs_url = "https://docs.gtk.org/gobject/"
+
+  [dependencies."Gnt-3.0"]
+  name = "Gnt"
+  description = "GLib NCurses Toolkit"
+  docs_url = "https://docs.imfreedom.org/gnt3/"
+
+  [dependencies."Purple-3.0"]
+  name = "Purple"
+  description = "Purple Universal Chat Library"
+  docs_url = "https://docs.imfreedom.org/purple3/"
+
+[theme]
+name = "basic"
+show_index_summary = true
+show_class_hierarchy = true
+
+[source-location]
+base_url = "https://keep.imfreedom.org/pidgin/pidgin/file/default/"
+
+[extra]
+# The same order will be used when generating the index
+content_files = [
+]
+content_images = [
+]
+urlmap_file = "urlmap.js"
--- a/doc/reference/finch/meson.build	Tue Oct 19 00:47:42 2021 -0500
+++ b/doc/reference/finch/meson.build	Tue Oct 19 00:48:05 2021 -0500
@@ -1,39 +1,32 @@
-DOC_MODULE = 'finch'
-
-# Header files or dirs to ignore when scanning. Use base file/dir names
-ignore_hfiles = [
-    'plugins',
-]
+finch_doc_content_files = []
 
-# Extra options to supply to gtkdoc-scan.
-scan_args = [
-    '--deprecated-guards=PURPLE_DISABLE_DEPRECATED|GNT_DISABLE_DEPRECATED|FINCH_DISABLE_DEPRECATED',
-    '--rebuild-types',
-    '--rebuild-sections',
-    '--ignore-headers=' + ' '.join(ignore_hfiles),
-]
-
-# Extra options to supply to gtkdoc-mkdb.
-mkdb_args = [
-    '--ignore-files=' + ' '.join(ignore_hfiles),
-]
+if get_option('doc')
+	finch_toml = configure_file(
+		input : 'finch.toml.in',
+		output : 'finch.toml',
+		configuration : version_conf,
+		install : true,
+		install_dir : docs_dir / 'finch',
+	)
 
-# Extra options to supply to fixxrefs
-fixxref_args = [
-    '--extra-dir=../libpurple',
-]
-
-configure_file(
-    input : 'version.xml.in',
-    output : 'version.xml',
-    configuration : version_conf)
+	finch_doc = custom_target('finch-doc',
+		input : [ finch_toml, libfinch_gir ],
+		output : 'finch',
+		command : [
+			gidocgen,
+			'generate',
+			'--quiet',
+			'--fatal-warnings',
+			'--config=@INPUT0@',
+			'--output-dir=@OUTPUT@',
+			'--no-namespace-dir',
+			'--content-dir=@0@'.format(meson.current_source_dir()),
+			'@INPUT1@'
+		],
+		depend_files : [ finch_doc_content_files ],
+		build_by_default : true,
+		install : true,
+		install_dir : docs_dir,
+	)
+endif
 
-finch_doc = gnome.gtkdoc(DOC_MODULE,
-    main_xml : DOC_MODULE + '-docs.xml',
-    src_dir : libfinch_inc,
-    dependencies : libfinch_dep,
-    install : true,
-    scan_args : scan_args,
-    mkdb_args : mkdb_args,
-    fixxref_args : fixxref_args,
-    gobject_typesfile : DOC_MODULE + '.types')
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/reference/finch/urlmap.js	Tue Oct 19 00:48:05 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
+baseURLs = [
+    [ 'GLib', 'https://docs.gtk.org/glib/' ],
+    [ 'GObject', 'https://docs.gtk.org/gobject/' ],
+    [ 'Gnt3', 'https://docs.imfreedom.org/gnt3/' ],
+    [ 'Purple3', 'https://docs.imfreedom.org/purple3/' ],
+]
--- a/doc/reference/finch/version.xml.in	Tue Oct 19 00:47:42 2021 -0500
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,1 +0,0 @@
-@PURPLE_VERSION@
--- a/finch/gntaccount.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntaccount.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_ACCOUNT_H
 #define FINCH_ACCOUNT_H
 
-/**
- * SECTION:gntaccount
- * @section_id: finch-gntaccount
- * @short_description: <filename>gntaccount.h</filename>
- * @title: Account API
- */
-
 #include <purple.h>
 
 /**********************************************************************
--- a/finch/gntblist.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntblist.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_BLIST_H
 #define FINCH_BLIST_H
 
-/**
- * SECTION:gntblist
- * @section_id: finch-gntblist
- * @short_description: <filename>gntblist.h</filename>
- * @title: Buddy List API
- */
-
 #include <purple.h>
 
 #include <gnt.h>
@@ -74,11 +67,6 @@
 	gpointer reserved[4];
 };
 
-/**
- * finch_blist_manager_get_type:
- *
- * Returns: The #GType for the #FinchBlistManager boxed structure.
- */
 GType finch_blist_manager_get_type(void);
 
 G_DECLARE_FINAL_TYPE(FinchBuddyList, finch_buddy_list, FINCH, BUDDY_LIST,
--- a/finch/gntconn.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntconn.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_CONN_H
 #define FINCH_CONN_H
 
-/**
- * SECTION:gntconn
- * @section_id: finch-gntconn
- * @short_description: <filename>gntconn.h</filename>
- * @title: Connection API
- */
-
 #include <purple.h>
 
 /**********************************************************************
--- a/finch/gntconv.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntconv.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_CONV_H
 #define FINCH_CONV_H
 
-/**
- * SECTION:gntconv
- * @section_id: finch-gntconv
- * @short_description: <filename>gntconv.h</filename>
- * @title: Conversation API
- */
-
 #include <gnt.h>
 
 #include <purple.h>
--- a/finch/gntdebug.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntdebug.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_DEBUG_H
 #define FINCH_DEBUG_H
 
-/**
- * SECTION:gntdebug
- * @section_id: finch-gntdebug
- * @short_description: <filename>gntdebug.h</filename>
- * @title: Debug API
- */
-
 #include <purple.h>
 
 G_BEGIN_DECLS
--- a/finch/gntidle.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntidle.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_IDLE_H
 #define FINCH_IDLE_H
 
-/**
- * SECTION:gntidle
- * @section_id: finch-gntidle
- * @short_description: <filename>gntidle.h</filename>
- * @title: Idle API
- */
-
 #include <purple.h>
 
 /**************************************************************************/
--- a/finch/gntmedia.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntmedia.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_MEDIA_H
 #define FINCH_MEDIA_H
 
-/**
- * SECTION:gntmedia
- * @section_id: finch-gntmedia
- * @short_description: <filename>gntmedia.h</filename>
- * @title: Media API
- */
-
 G_BEGIN_DECLS
 
 void finch_media_manager_init(void);
--- a/finch/gntmenuutil.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntmenuutil.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_MENUUTIL_H
 #define FINCH_MENUUTIL_H
 
-/**
- * SECTION:gntmenuutil
- * @section_id: finch-gntmenuutil
- * @short_description: <filename>gntmenuutil.h</filename>
- * @title: Menu Utility functions
- */
-
 #include <purple.h>
 
 #include <gnt.h>
--- a/finch/gntnotify.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntnotify.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_NOTIFY_H
 #define FINCH_NOTIFY_H
 
-/**
- * SECTION:gntnotify
- * @section_id: finch-gntnotify
- * @short_description: <filename>gntnotify.h</filename>
- * @title: Notify API
- */
-
 #include <purple.h>
 
 /**********************************************************************
--- a/finch/gntplugin.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntplugin.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_PLUGIN_H
 #define FINCH_PLUGIN_H
 
-/**
- * SECTION:gntplugin
- * @section_id: finch-gntplugin
- * @short_description: <filename>gntplugin.h</filename>
- * @title: Plugin API
- */
-
 #include <gnt.h>
 
 #include <purple.h>
@@ -80,11 +73,6 @@
  * Plugin Info API
  **********************************************************************/
 
-/**
- * finch_plugin_info_get_type:
- *
- * Returns: The #GType for the #FinchPluginInfo object.
- */
 GType finch_plugin_info_get_type(void);
 
 /**
--- a/finch/gntprefs.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntprefs.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_PREFS_H
 #define FINCH_PREFS_H
 
-/**
- * SECTION:gntprefs
- * @section_id: finch-gntprefs
- * @short_description: <filename>gntprefs.h</filename>
- * @title: Preferences API
- */
-
 /**********************************************************************
  * GNT Preferences API
  **********************************************************************/
--- a/finch/gntrequest.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntrequest.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_REQUEST_H
 #define FINCH_REQUEST_H
 
-/**
- * SECTION:gntrequest
- * @section_id: finch-gntrequest
- * @short_description: <filename>gntrequest.h</filename>
- * @title: Request API
- */
-
 #include <purple.h>
 
 #include "gnt.h"
--- a/finch/gntstatus.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntstatus.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_STATUS_H
 #define FINCH_STATUS_H
 
-/**
- * SECTION:gntstatus
- * @section_id: finch-gntstatus
- * @short_description: <filename>gntstatus.h</filename>
- * @title: Status API
- */
-
 #include <purple.h>
 
 /**********************************************************************
--- a/finch/gntui.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntui.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_UI_H
 #define FINCH_UI_H
 
-/**
- * SECTION:gntui
- * @section_id: finch-gntui
- * @short_description: <filename>gntui.h</filename>
- * @title: Startup and Shutdown UI
- */
-
 #include "gnt.h"
 
 void finch_ui_init(void);
--- a/finch/gntxfer.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/gntxfer.h	Tue Oct 19 00:48:05 2021 -0500
@@ -27,13 +27,6 @@
 #ifndef FINCH_XFER_H
 #define FINCH_XFER_H
 
-/**
- * SECTION:gntxfer
- * @section_id: finch-gntxfer
- * @short_description: <filename>gntxfer.h</filename>
- * @title: File Transfer UI
- */
-
 #include <purple.h>
 
 /**************************************************************************/
--- a/finch/libfinch.h	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/libfinch.h	Tue Oct 19 00:48:05 2021 -0500
@@ -32,13 +32,6 @@
 
 #define FINCH_PREFS_ROOT "/finch"
 
-/**
- * SECTION:finch
- * @section_id: finch-finch
- * @short_description: <filename>libfinch.h</filename>
- * @title: UI Definitions and Includes
- */
-
 G_BEGIN_DECLS
 
 /**
--- a/finch/meson.build	Tue Oct 19 00:47:42 2021 -0500
+++ b/finch/meson.build	Tue Oct 19 00:48:05 2021 -0500
@@ -195,26 +195,17 @@
 	if enable_introspection
 		introspection_sources = libfinch_headers
 
-		Finch_gir_includes = [
-			'Gnt-3.0',
-			'GPlugin-1.0',
-			# subproject needs to be before libpurple in the repo so that
-			# meson will use our variables and not try to discover them from
-			# libpurple.
-			libpurple_gir[0],
-		]
-
 		libfinch_gir = gnome.generate_gir(libfinch,
 		    sources : introspection_sources,
-		    includes : Finch_gir_includes,
 		    namespace : 'Finch',
 		    symbol_prefix : 'finch',
+		    header : 'finch.h',
 		    identifier_prefix : 'Finch',
-		    export_packages : 'finch',
+		    export_packages : 'finch-3',
 		    nsversion : '@0@.@1@'.format(purple_major_version,
 		                                 purple_minor_version),
 		    install : true,
-		    dependencies: [libgnt_dep, gplugin_dep],
+		    dependencies: [libgnt_dep, gplugin_dep, libpurple],
 		    extra_args : ['-DFINCH_COMPILATION', '--quiet'])
 		libfinch_generated_sources += libfinch_gir
 	endif

Mercurial Repository: pidgin3

mercurial