Add annotation for some return types
authorPeng Huang <shawn.p.huang@gmail.com>
Tue, 1 Jun 2010 11:17:46 +0000 (19:17 +0800)
committerPeng Huang <shawn.p.huang@gmail.com>
Tue, 1 Jun 2010 13:12:39 +0000 (21:12 +0800)
src/ibusbus.h
src/ibuscomponent.h
src/ibusobservedpath.h
src/ibusservice.h

index 8c10f50..cbf13ef 100644 (file)
@@ -146,7 +146,7 @@ gboolean     ibus_bus_name_has_owner    (IBusBus        *bus,
 /**
  * ibus_bus_list_names:
  * @bus: An IBusBus.
- * @returns: Lists that attached to @bus.
+ * @returns: (element-type utf8): Lists that attached to @bus.
  *
  * Return lists that attached to @bus.
  * <note><para>[FixMe] Not implemented yet, only return NULL.</para></note>
@@ -237,7 +237,7 @@ gboolean     ibus_bus_register_component(IBusBus        *bus,
 /**
  * ibus_bus_list_engines:
  * @bus: An IBusBus.
- * @returns: A GList of engines.
+ * @returns: (element-type IBusEngineDesc): A List of engines.
  *
  * List engines.
  * Note that this function is not yet implemented.
@@ -247,7 +247,7 @@ GList       *ibus_bus_list_engines      (IBusBus        *bus);
 /**
  * ibus_bus_list_active_engines:
  * @bus: An IBusBus.
- * @returns: A GList of active engines.
+ * @returns: (element-type IBusEngineDesc): A List of active engines.
  *
  * List active engines.
  * Note that this function is not yet implemented.
index 6c9e9e3..0a2f9df 100644 (file)
@@ -188,7 +188,7 @@ void             ibus_component_add_engine      (IBusComponent  *component,
 /**
  * ibus_component_get_engines:
  * @component: An IBusComponent.
- * @returns: A newly allocated GList that contains engines.
+ * @returns: (element-type IBusEngineDesc): A newly allocated GList that contains engines.
  *
  * Get the engines of this component.
  */
index 69d13c2..66791a2 100644 (file)
@@ -109,7 +109,7 @@ IBusObservedPath    *ibus_observed_path_new                 (const gchar
 /**
  * ibus_observed_path_traverse:
  * @path: An IBusObservedPath.
- * @returns: A newly allocate GList which holds content in path; NULL if @path is not directory.
+ * @returns: (element-type IBusObservedPath): A newly allocate GList which holds content in path; NULL if @path is not directory.
  *
  * Recursively traverse the path and put the files and subdirectory in to a newly allocated
  * GLists, if the @path is a directory. Otherwise returns NULL.
index 36ccd64..6923211 100644 (file)
@@ -155,7 +155,7 @@ gboolean         ibus_service_add_to_connection (IBusService    *service,
 /**
  * ibus_service_get_connections:
  * @service: An IBusService.
- * @returns: A newly allocated list of connections.
+ * @returns: (element-type IBusConnection): A newly allocated list of connections.
  *
  * Returns a copy of list of connections.
  * List elements need to be unref by g_object_unref().