From b5b34fa2f2711bea9b98a7b14882d8bda06c580b Mon Sep 17 00:00:00 2001 From: David Zeuthen Date: Sat, 23 Apr 2011 17:43:03 -0400 Subject: [PATCH] gdbus-codegen: Include docs for generated code in the GIO docs Signed-off-by: David Zeuthen --- docs/reference/gio/Makefile.am | 1 + docs/reference/gio/gio-sections.txt | 117 ++++++++++++++++++++++++ docs/reference/gio/gio.types | 7 ++ docs/reference/gio/migrating-gdbus.xml | 16 +++- gio/Makefile.am | 28 ++++++ gio/{tests => }/gdbus-example-objectmanager.xml | 0 gio/tests/Makefile.am | 21 +---- 7 files changed, 167 insertions(+), 23 deletions(-) rename gio/{tests => }/gdbus-example-objectmanager.xml (100%) diff --git a/docs/reference/gio/Makefile.am b/docs/reference/gio/Makefile.am index 70e5d74..30de059 100644 --- a/docs/reference/gio/Makefile.am +++ b/docs/reference/gio/Makefile.am @@ -128,6 +128,7 @@ GTKDOC_LIBS = \ $(top_builddir)/gobject/libgobject-2.0.la \ $(top_builddir)/gmodule/libgmodule-2.0.la \ $(top_builddir)/gio/libgio-2.0.la \ + $(top_builddir)/gio/libgdbus-example-objectmanager.la \ $(NULL) # Extra options to supply to gtkdoc-mkdb diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt index 656417f..0d733a1 100644 --- a/docs/reference/gio/gio-sections.txt +++ b/docs/reference/gio/gio-sections.txt @@ -3300,3 +3300,120 @@ G_DBUS_OBJECT_MANAGER_SERVER_GET_CLASS GDBusObjectManagerServerPrivate + +
+ExampleAnimal +ExampleAnimal +ExampleAnimal +ExampleAnimalIface +example_animal_interface_info +example_animal_override_properties +example_animal_call_poke +example_animal_call_poke_finish +example_animal_call_poke_sync +example_animal_complete_poke +example_animal_emit_jumped +example_animal_get_mood +example_animal_set_mood +ExampleAnimalProxy +ExampleAnimalProxyClass +example_animal_proxy_new +example_animal_proxy_new_finish +example_animal_proxy_new_sync +example_animal_proxy_new_for_bus +example_animal_proxy_new_for_bus_finish +example_animal_proxy_new_for_bus_sync +ExampleAnimalSkeleton +ExampleAnimalSkeletonClass +example_animal_skeleton_new + +example_animal_get_type +example_animal_proxy_get_type +example_animal_skeleton_get_type +ExampleAnimalSkeletonPrivate +ExampleAnimalProxyPrivate +EXAMPLE_TYPE_ANIMAL +EXAMPLE_TYPE_ANIMAL_PROXY +EXAMPLE_TYPE_ANIMAL_SKELETON +EXAMPLE_ANIMAL +EXAMPLE_ANIMAL_GET_IFACE +EXAMPLE_ANIMAL_PROXY +EXAMPLE_ANIMAL_PROXY_CLASS +EXAMPLE_ANIMAL_PROXY_GET_CLASS +EXAMPLE_ANIMAL_SKELETON +EXAMPLE_ANIMAL_SKELETON_CLASS +EXAMPLE_ANIMAL_SKELETON_GET_CLASS +EXAMPLE_PEEK_ANIMAL +EXAMPLE_GET_ANIMAL +EXAMPLE_IS_ANIMAL +EXAMPLE_IS_ANIMAL_PROXY +EXAMPLE_IS_ANIMAL_PROXY_CLASS +EXAMPLE_IS_ANIMAL_SKELETON +EXAMPLE_IS_ANIMAL_SKELETON_CLASS +
+ +
+ExampleCat +ExampleCat +ExampleCat +ExampleCatIface +example_cat_interface_info +ExampleCatProxy +ExampleCatProxyClass +example_cat_proxy_new +example_cat_proxy_new_finish +example_cat_proxy_new_sync +example_cat_proxy_new_for_bus +example_cat_proxy_new_for_bus_finish +example_cat_proxy_new_for_bus_sync +ExampleCatSkeleton +ExampleCatSkeletonClass +example_cat_skeleton_new + +example_cat_get_type +example_cat_proxy_get_type +example_cat_skeleton_get_type +ExampleCatProxyPrivate +ExampleCatSkeletonPrivate +EXAMPLE_TYPE_CAT +EXAMPLE_TYPE_CAT_PROXY +EXAMPLE_TYPE_CAT_SKELETON +EXAMPLE_CAT +EXAMPLE_CAT_GET_IFACE +EXAMPLE_CAT_PROXY +EXAMPLE_CAT_PROXY_CLASS +EXAMPLE_CAT_PROXY_GET_CLASS +EXAMPLE_CAT_SKELETON +EXAMPLE_CAT_SKELETON_CLASS +EXAMPLE_CAT_SKELETON_GET_CLASS +EXAMPLE_PEEK_CAT +EXAMPLE_GET_CAT +EXAMPLE_IS_CAT +EXAMPLE_IS_CAT_PROXY +EXAMPLE_IS_CAT_PROXY_CLASS +EXAMPLE_IS_CAT_SKELETON +EXAMPLE_IS_CAT_SKELETON_CLASS +
+ +
+ExampleObjectManagerClient +ExampleObjectManagerClient +ExampleObjectManagerClient +ExampleObjectManagerClientClass +example_object_manager_client_get_proxy_type +example_object_manager_client_new +example_object_manager_client_new_finish +example_object_manager_client_new_sync +example_object_manager_client_new_for_bus +example_object_manager_client_new_for_bus_finish +example_object_manager_client_new_for_bus_sync + +example_object_manager_client_get_type +EXAMPLE_IS_OBJECT_MANAGER_CLIENT +EXAMPLE_IS_OBJECT_MANAGER_CLIENT_CLASS +EXAMPLE_OBJECT_MANAGER_CLIENT +EXAMPLE_OBJECT_MANAGER_CLIENT_CLASS +EXAMPLE_OBJECT_MANAGER_CLIENT_GET_CLASS +EXAMPLE_TYPE_OBJECT_MANAGER_CLIENT +ExampleObjectManagerClientPrivate +
diff --git a/docs/reference/gio/gio.types b/docs/reference/gio/gio.types index 3a798f3..b40f683 100644 --- a/docs/reference/gio/gio.types +++ b/docs/reference/gio/gio.types @@ -1,3 +1,10 @@ +example_animal_get_type +example_animal_proxy_get_type +example_animal_skeleton_get_type +example_cat_get_type +example_cat_proxy_get_type +example_cat_skeleton_get_type +example_object_manager_client_get_type g_action_get_type g_simple_action_get_type g_action_group_get_type diff --git a/docs/reference/gio/migrating-gdbus.xml b/docs/reference/gio/migrating-gdbus.xml index ba2aa94..5d82eaa 100644 --- a/docs/reference/gio/migrating-gdbus.xml +++ b/docs/reference/gio/migrating-gdbus.xml @@ -247,7 +247,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 If this XML is processed like this gdbus-codegen manual page, brief examples of how this generated code can be used can be found in - and - . + and . Additionally, since + the generated code has 100% gtk-doc coverage, see + #ExampleAnimal, #ExampleCat and #ExampleObjectManagerClient + pages for documentation Server-side application using generated codeFIXME: MISSING XINCLUDE CONTENT @@ -287,7 +290,10 @@ gdbus-codegen --interface-prefix org.gtk.GDBus.Example.ObjectManager. \ - - + + + + + diff --git a/gio/Makefile.am b/gio/Makefile.am index 32ad95a..89d85db 100644 --- a/gio/Makefile.am +++ b/gio/Makefile.am @@ -651,6 +651,34 @@ completion_SCRIPTS = \ EXTRA_DIST += $(completion_SCRIPTS) # ------------------------------------------------------------------------ +# generate code here for the sake of gtk-doc + +gdbus-example-objectmanager-generated.h gdbus-example-objectmanager-generated.c : gdbus-example-objectmanager.xml + $(PYTHON) $(top_srcdir)/gio/gdbus-codegen/codegen_main.py \ + --interface-prefix org.gtk.GDBus.Example.ObjectManager. \ + --c-namespace Example \ + --c-generate-object-manager \ + --generate-c-code gdbus-example-objectmanager-generated \ + --generate-docbook gdbus-example-objectmanager-generated \ + gdbus-example-objectmanager.xml \ + $(NULL) + +BUILT_SOURCES += gdbus-example-objectmanager-generated.h gdbus-example-objectmanager-generated.c + +noinst_LTLIBRARIES = libgdbus-example-objectmanager.la +libgdbus_example_objectmanager_la_SOURCES = gdbus-example-objectmanager-generated.h gdbus-example-objectmanager-generated.c +libgdbus_example_objectmanager_la_LIBADD = \ + $(top_builddir)/glib/libglib-2.0.la \ + $(top_builddir)/gobject/libgobject-2.0.la \ + $(top_builddir)/gmodule/libgmodule-2.0.la \ + libgio-2.0.la \ + $(NULL) + +EXTRA_DIST += gdbus-example-objectmanager.xml + +CLEANFILES += gdbus-example-objectmanager-generated-*.xml + +# ------------------------------------------------------------------------ dist-hook: $(BUILT_EXTRA_DIST) ../build/win32/vs9/gio.vcproj ../build/win32/vs10/gio.vcxproj ../build/win32/vs10/gio.vcxproj.filters files='$(BUILT_EXTRA_DIST)'; \ diff --git a/gio/tests/gdbus-example-objectmanager.xml b/gio/gdbus-example-objectmanager.xml similarity index 100% rename from gio/tests/gdbus-example-objectmanager.xml rename to gio/gdbus-example-objectmanager.xml diff --git a/gio/tests/Makefile.am b/gio/tests/Makefile.am index 998faaa..ac4e855 100644 --- a/gio/tests/Makefile.am +++ b/gio/tests/Makefile.am @@ -442,25 +442,11 @@ proxy_LDADD = $(progs_ldadd) \ # ---------------------------------------------------------------------------------------------------- -gdbus-example-objectmanager-generated.h gdbus-example-objectmanager-generated.c : gdbus-example-objectmanager.xml - $(PYTHON) $(top_srcdir)/gio/gdbus-codegen/codegen_main.py \ - --interface-prefix org.gtk.GDBus.Example.ObjectManager. \ - --c-namespace Example \ - --c-generate-object-manager \ - --generate-c-code gdbus-example-objectmanager-generated \ - --generate-docbook gdbus-example-objectmanager-generated \ - gdbus-example-objectmanager.xml \ - $(NULL) - -BUILT_SOURCES += gdbus-example-objectmanager-generated.h gdbus-example-objectmanager-generated.c - gdbus_example_objectmanager_server_SOURCES = gdbus-example-objectmanager-server.c -gdbus_example_objectmanager_server_SOURCES += gdbus-example-objectmanager-generated.h gdbus-example-objectmanager-generated.c -gdbus_example_objectmanager_server_LDADD= $(progs_ldadd) +gdbus_example_objectmanager_server_LDADD = $(top_builddir)/gio/libgdbus-example-objectmanager.la $(progs_ldadd) gdbus_example_objectmanager_client_SOURCES = gdbus-example-objectmanager-client.c -gdbus_example_objectmanager_client_SOURCES += gdbus-example-objectmanager-generated.h gdbus-example-objectmanager-generated.c -gdbus_example_objectmanager_client_LDADD= $(progs_ldadd) +gdbus_example_objectmanager_client_LDADD = $(top_builddir)/gio/libgdbus-example-objectmanager.la $(progs_ldadd) # ---------------------------------------------------------------------------------------------------- @@ -478,7 +464,6 @@ EXTRA_DIST += \ appinfo-test-notgnome.desktop \ gdbus-testserver.py \ test-codegen.xml \ - gdbus-example-objectmanager.xml \ $(NULL) MISC_STUFF = test.mo @@ -488,7 +473,7 @@ test.mo: de.po $(MKDIR_P) de/LC_MESSAGES; \ cp -f test.mo de/LC_MESSAGES -CLEANFILES = gdbus-test-codegen-generated.[ch] gdbus-test-codegen-generated-doc-*.xml gdbus-example-objectmanager-generated-*.xml +CLEANFILES = gdbus-test-codegen-generated.[ch] gdbus-test-codegen-generated-doc-*.xml DISTCLEANFILES = \ applications/mimeinfo.cache \ -- 2.7.4