From db2cb16e20f0c335dbc045bdebe83877b53a31c6 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Fri, 30 Oct 2020 16:39:10 +0000 Subject: [PATCH 1/3] docs: Add missing annotation glossary Without the glossary, gtk-doc will emit warnings for every introspection annotation it finds. --- .../gdbus-object-manager-example-docs.xml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/reference/gio/gdbus-object-manager-example/gdbus-object-manager-example-docs.xml b/docs/reference/gio/gdbus-object-manager-example/gdbus-object-manager-example-docs.xml index 7b0d1cacb..fd4c30736 100644 --- a/docs/reference/gio/gdbus-object-manager-example/gdbus-object-manager-example-docs.xml +++ b/docs/reference/gio/gdbus-object-manager-example/gdbus-object-manager-example-docs.xml @@ -5,13 +5,15 @@ ]> - foo + GDBus ObjctManager Example - bar + Interfaces + + From 2993bb8275ab0c39b177a9de4556feb60a56c8c8 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Fri, 30 Oct 2020 16:41:07 +0000 Subject: [PATCH 2/3] docs: Fix xinclude directives For legacy reasons, Meson's gtk-doc helper script launches the gtkdoc-mkhtml tool in the `html` directory under the build root. This means that all paths must be relative to that location. --- docs/reference/gio/migrating-gdbus.xml | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/reference/gio/migrating-gdbus.xml b/docs/reference/gio/migrating-gdbus.xml index 5e2d46474..dc4ee75d9 100644 --- a/docs/reference/gio/migrating-gdbus.xml +++ b/docs/reference/gio/migrating-gdbus.xml @@ -254,7 +254,7 @@ on_name_acquired (GDBusConnection *connection, linkend="gdbus-codegen">gdbus-codegen is used and like its counterpart, it also takes D-Bus Introspection XML as input: - Example D-Bus Introspection XMLFIXME: MISSING XINCLUDE CONTENT + Example D-Bus Introspection XMLFIXME: MISSING XINCLUDE CONTENT: gdbus-example-objectmanager.xml If this XML is processed like this - Server-side application using generated codeFIXME: MISSING XINCLUDE CONTENT + Server-side application using generated codeFIXME: MISSING XINCLUDE CONTENT: gdbus-example-objectmanager-server.c - Client-side application using generated codeFIXME: MISSING XINCLUDE CONTENT + Client-side application using generated codeFIXME: MISSING XINCLUDE CONTENT: gdbus-example-objectmanager-client.c - - - - - - + + FIXME: MISSING XINCLUDE CONTENT: objectmanager-gen-org.gtk.GDBus.Example.ObjectManager.Animal.xml + FIXME: MISSING XINCLUDE CONTENT: objectmanager-gen-org.gtk.GDBus.Example.ObjectManager.Cat.xml + FIXME: MISSING XINCLUDE CONTENT: ExampleAnimal.xml + FIXME: MISSING XINCLUDE CONTENT: ExampleCat.xml + FIXME: MISSING XINCLUDE CONTENT: ExampleObject.xml + FIXME: MISSING XINCLUDE CONTENT: ExampleObjectManagerClient.xml From e1744603d8c8b4ac9763854ce658c241b3c5fc3a Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Fri, 30 Oct 2020 16:42:53 +0000 Subject: [PATCH 3/3] Build gdbus-objectmanager-example docs unconditionally The GIO reference documentation links to that documentation, so we cannot only build it when the installed tests are enabled. --- docs/reference/gio/meson.build | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/docs/reference/gio/meson.build b/docs/reference/gio/meson.build index a4e67ca82..acdd5ece7 100644 --- a/docs/reference/gio/meson.build +++ b/docs/reference/gio/meson.build @@ -1,7 +1,5 @@ if get_option('gtk_doc') - if installed_tests_enabled - subdir('gdbus-object-manager-example') - endif + subdir('gdbus-object-manager-example') subdir('xml') ignore_headers = [ @@ -178,13 +176,11 @@ if get_option('gtk_doc') 'gdbus-codegen.xml', ] - if installed_tests_enabled - content_files += [ - gdbus_example_objectmanager_xml, - gdbus_example_objectmanager_sources, - gdbus_object_manager_example_doc - ] - endif + content_files += [ + gdbus_example_objectmanager_xml, + gdbus_example_objectmanager_sources, + gdbus_object_manager_example_doc + ] gnome.gtkdoc('gio', main_xml : 'gio-docs.xml',