luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-26 15:36:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

gdbus-codegen: Include docs for generated code in the GIO docs

Browse Source 
Signed-off-by: David Zeuthen <davidz@redhat.com>
This commit is contained in:
David Zeuthen 2011-04-23 17:43:03 -04:00
parent f0eeadf306
commit b5b34fa2f2
7 changed files with 167 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/reference/gio/Makefile.am
View File

@ -128,6 +128,7 @@ GTKDOC_LIBS = \
$(top_builddir)/gobject/libgobject-2.0.la \ $(top_builddir)/gobject/libgobject-2.0.la \
$(top_builddir)/gmodule/libgmodule-2.0.la \ $(top_builddir)/gmodule/libgmodule-2.0.la \
$(top_builddir)/gio/libgio-2.0.la \ $(top_builddir)/gio/libgio-2.0.la \
$(top_builddir)/gio/libgdbus-example-objectmanager.la \
$(NULL) $(NULL)
# Extra options to supply to gtkdoc-mkdb # Extra options to supply to gtkdoc-mkdb

117
docs/reference/gio/gio-sections.txt
View File

@ -3300,3 +3300,120 @@ G_DBUS_OBJECT_MANAGER_SERVER_GET_CLASS
<SUBSECTION Private> <SUBSECTION Private>
GDBusObjectManagerServerPrivate GDBusObjectManagerServerPrivate
</SECTION> </SECTION>
<SECTION>
<FILE>ExampleAnimal</FILE>
<TITLE>ExampleAnimal</TITLE>
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
<SUBSECTION Standard>
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
</SECTION>
<SECTION>
<FILE>ExampleCat</FILE>
<TITLE>ExampleCat</TITLE>
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
<SUBSECTION Standard>
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
</SECTION>
<SECTION>
<FILE>ExampleObjectManagerClient</FILE>
<TITLE>ExampleObjectManagerClient</TITLE>
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
<SUBSECTION Standard>
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
</SECTION>

7
docs/reference/gio/gio.types
View File

@ -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_action_get_type
g_simple_action_get_type g_simple_action_get_type
g_action_group_get_type g_action_group_get_type

16
docs/reference/gio/migrating-gdbus.xml
View File

@ -247,7 +247,7 @@ on_name_acquired (GDBusConnection *connection,
linkend="gdbus-codegen">gdbus-codegen</link></command> is used and like linkend="gdbus-codegen">gdbus-codegen</link></command> is used and like
its counterpart, it also takes D-Bus Introspection XML as input: its counterpart, it also takes D-Bus Introspection XML as input:
</para> </para>
<example id="gdbus-example-codegen-input"><title>Example D-Bus Introspection XML</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-objectmanager.xml"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example> <example id="gdbus-example-codegen-input"><title>Example D-Bus Introspection XML</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/gdbus-example-objectmanager.xml"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
<para> <para>
If this XML is processed like this If this XML is processed like this
<informalexample><programlisting><![CDATA[ <informalexample><programlisting><![CDATA[
@ -277,8 +277,11 @@ gdbus-codegen --interface-prefix org.gtk.GDBus.Example.ObjectManager. \
linkend="gdbus-codegen">gdbus-codegen</link></command> manual linkend="gdbus-codegen">gdbus-codegen</link></command> manual
page, brief examples of how this generated code can be used can be found in page, brief examples of how this generated code can be used can be found in
<xref linkend="gdbus-example-codegen-server"/> <xref linkend="gdbus-example-codegen-server"/>
and and <xref
<xref linkend="gdbus-example-codegen-client"/>. linkend="gdbus-example-codegen-client"/>. Additionally, since
the generated code has 100% gtk-doc coverage, see
#ExampleAnimal, #ExampleCat and #ExampleObjectManagerClient
pages for documentation
</para> </para>
<example id="gdbus-example-codegen-server"><title>Server-side application using generated code</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-objectmanager-server.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example> <example id="gdbus-example-codegen-server"><title>Server-side application using generated code</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-objectmanager-server.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
@ -287,7 +290,10 @@ gdbus-codegen --interface-prefix org.gtk.GDBus.Example.ObjectManager. \
</section> </section>
<xi:include href="../../../../gio/tests/gdbus-example-objectmanager-generated-org.gtk.GDBus.Example.ObjectManager.Animal.xml"/> <xi:include href="../../../../gio/gdbus-example-objectmanager-generated-org.gtk.GDBus.Example.ObjectManager.Animal.xml"/>
<xi:include href="../../../../gio/tests/gdbus-example-objectmanager-generated-org.gtk.GDBus.Example.ObjectManager.Cat.xml"/> <xi:include href="../../../../gio/gdbus-example-objectmanager-generated-org.gtk.GDBus.Example.ObjectManager.Cat.xml"/>
<xi:include href="ExampleAnimal.xml"/>
<xi:include href="ExampleCat.xml"/>
<xi:include href="ExampleObjectManagerClient.xml"/>
</chapter> </chapter>

28
gio/Makefile.am
View File

@ -650,6 +650,34 @@ completion_SCRIPTS = \
gsettings-bash-completion.sh gsettings-bash-completion.sh
EXTRA_DIST += $(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 dist-hook: $(BUILT_EXTRA_DIST) ../build/win32/vs9/gio.vcproj ../build/win32/vs10/gio.vcxproj ../build/win32/vs10/gio.vcxproj.filters

0
gio/tests/gdbus-example-objectmanager.xml → gio/gdbus-example-objectmanager.xml
View File

21
gio/tests/Makefile.am
View File

@ -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-server.c
gdbus_example_objectmanager_server_SOURCES += gdbus-example-objectmanager-generated.h gdbus-example-objectmanager-generated.c gdbus_example_objectmanager_server_LDADD = $(top_builddir)/gio/libgdbus-example-objectmanager.la $(progs_ldadd)
gdbus_example_objectmanager_server_LDADD= $(progs_ldadd)
gdbus_example_objectmanager_client_SOURCES = gdbus-example-objectmanager-client.c 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 = $(top_builddir)/gio/libgdbus-example-objectmanager.la $(progs_ldadd)
gdbus_example_objectmanager_client_LDADD= $(progs_ldadd)
# ---------------------------------------------------------------------------------------------------- # ----------------------------------------------------------------------------------------------------
@ -478,7 +464,6 @@ EXTRA_DIST += \
appinfo-test-notgnome.desktop \ appinfo-test-notgnome.desktop \
gdbus-testserver.py \ gdbus-testserver.py \
test-codegen.xml \ test-codegen.xml \
gdbus-example-objectmanager.xml \
$(NULL) $(NULL)
MISC_STUFF = test.mo MISC_STUFF = test.mo
@ -488,7 +473,7 @@ test.mo: de.po
$(MKDIR_P) de/LC_MESSAGES; \ $(MKDIR_P) de/LC_MESSAGES; \
cp -f test.mo 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 = \ DISTCLEANFILES = \
applications/mimeinfo.cache \ applications/mimeinfo.cache \