summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Zeuthen <davidz@redhat.com>2008-12-21 18:21:12 -0500
committerDavid Zeuthen <davidz@redhat.com>2008-12-21 18:21:12 -0500
commitaa1bfb3c7c762b5264b27d6910f52f14f0c24698 (patch)
tree636908a710174a204ffedec94f678198b963f69a
parent4a099864b7c0afbac4a0332e955da8ee5d2b2b40 (diff)
make sure all generated _sync() methods are the first ones listed
This makes it a bit easier to look at the generated gtk-doc output.
-rw-r--r--docs/eggdbus/eggdbus-sections.txt48
-rw-r--r--src/eggdbus/interface.c36
2 files changed, 54 insertions, 30 deletions
diff --git a/docs/eggdbus/eggdbus-sections.txt b/docs/eggdbus/eggdbus-sections.txt
index 61e4ecc..1c0b327 100644
--- a/docs/eggdbus/eggdbus-sections.txt
+++ b/docs/eggdbus/eggdbus-sections.txt
@@ -115,60 +115,60 @@ EggDBusRequestNameFlags
EggDBusRequestNameReply
EggDBusReleaseNameReply
EggDBusStartServiceByNameReply
+egg_dbus_bus_invoke_hello_sync
+egg_dbus_bus_invoke_request_name_sync
+egg_dbus_bus_invoke_release_name_sync
+egg_dbus_bus_invoke_start_service_by_name_sync
+egg_dbus_bus_invoke_update_activation_environment_sync
+egg_dbus_bus_invoke_name_has_owner_sync
+egg_dbus_bus_invoke_list_names_sync
+egg_dbus_bus_invoke_list_activatable_names_sync
+egg_dbus_bus_invoke_add_match_sync
+egg_dbus_bus_invoke_remove_match_sync
+egg_dbus_bus_invoke_get_name_owner_sync
+egg_dbus_bus_invoke_list_queued_owners_sync
+egg_dbus_bus_invoke_get_connection_unix_user_sync
+egg_dbus_bus_invoke_get_connection_unix_process_id_sync
+egg_dbus_bus_invoke_get_adt_audit_session_data_sync
+egg_dbus_bus_invoke_get_connection_se_linux_security_context_sync
+egg_dbus_bus_invoke_reload_config_sync
+egg_dbus_bus_invoke_get_id_sync
egg_dbus_bus_invoke_hello
egg_dbus_bus_invoke_hello_finish
-egg_dbus_bus_invoke_hello_sync
egg_dbus_bus_invoke_request_name
egg_dbus_bus_invoke_request_name_finish
-egg_dbus_bus_invoke_request_name_sync
egg_dbus_bus_invoke_release_name
egg_dbus_bus_invoke_release_name_finish
-egg_dbus_bus_invoke_release_name_sync
egg_dbus_bus_invoke_start_service_by_name
egg_dbus_bus_invoke_start_service_by_name_finish
-egg_dbus_bus_invoke_start_service_by_name_sync
egg_dbus_bus_invoke_update_activation_environment
egg_dbus_bus_invoke_update_activation_environment_finish
-egg_dbus_bus_invoke_update_activation_environment_sync
egg_dbus_bus_invoke_name_has_owner
egg_dbus_bus_invoke_name_has_owner_finish
-egg_dbus_bus_invoke_name_has_owner_sync
egg_dbus_bus_invoke_list_names
egg_dbus_bus_invoke_list_names_finish
-egg_dbus_bus_invoke_list_names_sync
egg_dbus_bus_invoke_list_activatable_names
egg_dbus_bus_invoke_list_activatable_names_finish
-egg_dbus_bus_invoke_list_activatable_names_sync
egg_dbus_bus_invoke_add_match
egg_dbus_bus_invoke_add_match_finish
-egg_dbus_bus_invoke_add_match_sync
egg_dbus_bus_invoke_remove_match
egg_dbus_bus_invoke_remove_match_finish
-egg_dbus_bus_invoke_remove_match_sync
egg_dbus_bus_invoke_get_name_owner
egg_dbus_bus_invoke_get_name_owner_finish
-egg_dbus_bus_invoke_get_name_owner_sync
egg_dbus_bus_invoke_list_queued_owners
egg_dbus_bus_invoke_list_queued_owners_finish
-egg_dbus_bus_invoke_list_queued_owners_sync
egg_dbus_bus_invoke_get_connection_unix_user
egg_dbus_bus_invoke_get_connection_unix_user_finish
-egg_dbus_bus_invoke_get_connection_unix_user_sync
egg_dbus_bus_invoke_get_connection_unix_process_id
egg_dbus_bus_invoke_get_connection_unix_process_id_finish
-egg_dbus_bus_invoke_get_connection_unix_process_id_sync
egg_dbus_bus_invoke_get_adt_audit_session_data
egg_dbus_bus_invoke_get_adt_audit_session_data_finish
-egg_dbus_bus_invoke_get_adt_audit_session_data_sync
egg_dbus_bus_invoke_get_connection_se_linux_security_context
egg_dbus_bus_invoke_get_connection_se_linux_security_context_finish
-egg_dbus_bus_invoke_get_connection_se_linux_security_context_sync
egg_dbus_bus_invoke_reload_config
egg_dbus_bus_invoke_reload_config_finish
-egg_dbus_bus_invoke_reload_config_sync
egg_dbus_bus_invoke_get_id
egg_dbus_bus_invoke_get_id_finish
-egg_dbus_bus_invoke_get_id_sync
egg_dbus_bus_handle_hello_finish
egg_dbus_bus_handle_request_name_finish
egg_dbus_bus_handle_release_name_finish
@@ -311,12 +311,12 @@ EGG_DBUS_MESSAGE_GET_CLASS
EggDBusPeer
EggDBusPeerIface
EGG_DBUS_QUERY_INTERFACE_PEER
+egg_dbus_peer_invoke_ping_sync
+egg_dbus_peer_invoke_get_machine_id_sync
egg_dbus_peer_invoke_ping
egg_dbus_peer_invoke_ping_finish
-egg_dbus_peer_invoke_ping_sync
egg_dbus_peer_invoke_get_machine_id
egg_dbus_peer_invoke_get_machine_id_finish
-egg_dbus_peer_invoke_get_machine_id_sync
egg_dbus_peer_handle_ping_finish
egg_dbus_peer_handle_get_machine_id_finish
<SUBSECTION Standard>
@@ -332,9 +332,9 @@ EGG_DBUS_PEER_GET_IFACE
EggDBusIntrospectable
EggDBusIntrospectableIface
EGG_DBUS_QUERY_INTERFACE_INTROSPECTABLE
+egg_dbus_introspectable_invoke_introspect_sync
egg_dbus_introspectable_invoke_introspect
egg_dbus_introspectable_invoke_introspect_finish
-egg_dbus_introspectable_invoke_introspect_sync
egg_dbus_introspectable_handle_introspect_finish
<SUBSECTION Standard>
EGG_DBUS_INTROSPECTABLE
@@ -518,15 +518,15 @@ EGG_DBUS_ARRAY_SEQ_GET_CLASS
EggDBusProperties
EggDBusPropertiesIface
EGG_DBUS_QUERY_INTERFACE_PROPERTIES
+egg_dbus_properties_invoke_get_sync
+egg_dbus_properties_invoke_get_all_sync
+egg_dbus_properties_invoke_set_sync
egg_dbus_properties_invoke_get
egg_dbus_properties_invoke_get_finish
-egg_dbus_properties_invoke_get_sync
egg_dbus_properties_invoke_get_all
egg_dbus_properties_invoke_get_all_finish
-egg_dbus_properties_invoke_get_all_sync
egg_dbus_properties_invoke_set
egg_dbus_properties_invoke_set_finish
-egg_dbus_properties_invoke_set_sync
egg_dbus_properties_handle_get_finish
egg_dbus_properties_handle_get_all_finish
egg_dbus_properties_handle_set_finish
diff --git a/src/eggdbus/interface.c b/src/eggdbus/interface.c
index 5cd5323..abbd892 100644
--- a/src/eggdbus/interface.c
+++ b/src/eggdbus/interface.c
@@ -202,8 +202,10 @@ print_method_doc (const EggDBusInterfaceMethodInfo *method,
method_doc_string);
g_print (" *\n"
- " * This function synchronously invokes the <literal>%s.%s()</literal> method on the object represented by @instance.\n",
- interface->name, method->name);
+ " * This function synchronously invokes the <literal>%s.%s()</literal> method on the object represented by @instance.\n"
+ " * See %s_%s_invoke_%s() for the asynchronous version of this function.\n",
+ interface->name, method->name,
+ name_space_uscore, iface_name_uscore, method_name_uscore);
}
else if (method_type == METHOD_TYPE_ASYNC)
@@ -233,8 +235,10 @@ print_method_doc (const EggDBusInterfaceMethodInfo *method,
" * This function asynchronously invokes the <literal>%s.%s()</literal> method\n"
" * on the object represented by @instance.\n"
" * When the reply is ready, @callback will be called (on the main thread).\n"
- " * You can then call %s_%s_invoke_%s_finish() to get the result.\n",
+ " * You can then call %s_%s_invoke_%s_finish() to get the result.\n"
+ " * See %s_%s_invoke_%s_sync() for the synchronous version of this function.\n",
interface->name, method->name,
+ name_space_uscore, iface_name_uscore, method_name_uscore,
name_space_uscore, iface_name_uscore, method_name_uscore);
}
@@ -900,13 +904,33 @@ interface_generate_iface_h_file (const EggDBusInterfaceInfo *interface,
g_free (prop_name_uscore);
}
- /* prototype for methods */
+ /* prototypes for sync methods (we want these to appear first in the gtkdoc output) */
+ for (n = 0; n < interface->num_methods; n++)
+ {
+ const EggDBusInterfaceMethodInfo *method = interface->methods + n;
+ if (!print_method_prototype (method,
+ name_space_uscore,
+ iface_name_uscore,
+ full_instance_name,
+ METHOD_TYPE_SYNC,
+ 0,
+ "",
+ TRUE,
+ FALSE,
+ FALSE,
+ TRUE,
+ error))
+ goto out;
+ g_print ("\n");
+ }
+
+ /* prototypes for remaining methods (async, async_finish) */
for (n = 0; n < interface->num_methods; n++)
{
const EggDBusInterfaceMethodInfo *method = interface->methods + n;
- MethodType method_types[3] = {METHOD_TYPE_ASYNC, METHOD_TYPE_ASYNC_FINISH, METHOD_TYPE_SYNC};
+ MethodType method_types[2] = {METHOD_TYPE_ASYNC, METHOD_TYPE_ASYNC_FINISH};
- for (m = 0; m < 3; m++)
+ for (m = 0; m < 2; m++)
{
if (!print_method_prototype (method,
name_space_uscore,