Fix annotation in ibus_bus_create_input_context
authorfujiwarat <takao.fujiwara1@gmail.com>
Thu, 21 Feb 2013 03:41:08 +0000 (12:41 +0900)
committerfujiwarat <takao.fujiwara1@gmail.com>
Thu, 21 Feb 2013 03:41:08 +0000 (12:41 +0900)
BUG=http://code.google.com/p/ibus/issues/detail?id=1593

Review URL: https://codereview.appspot.com/7368044

src/ibusbus.h
src/ibusinputcontext.h
src/ibuspanelservice.h

index 8fe0036..7673365 100644 (file)
@@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif
 
+#ifndef __IBUS_BUS_H_
+#define __IBUS_BUS_H_
+
 /**
  * SECTION: ibusbus
  * @short_description: Connect with IBus daemon.
@@ -31,9 +34,6 @@
  *
  * An IBusBus connects with IBus daemon.
  */
-#ifndef __IBUS_BUS_H_
-#define __IBUS_BUS_H_
-
 #include <gio/gio.h>
 #include "ibusinputcontext.h"
 #include "ibusconfig.h"
@@ -489,8 +489,8 @@ gboolean    ibus_bus_exit_async_finish  (IBusBus        *bus,
  * ibus_bus_create_input_context:
  * @bus: An #IBusBus.
  * @client_name: Name of client.
- * @returns: An newly allocated #IBusInputContext if the "CreateInputContext"
- *      call is suceeded, %NULL otherwise.
+ * @returns: (transfer full): An newly allocated #IBusInputContext if the
+ *      "CreateInputContext" call is suceeded, %NULL otherwise.
  *
  * Create an input context for client synchronously.
  */
@@ -526,8 +526,8 @@ void        ibus_bus_create_input_context_async
  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
  *   ibus_bus_create_input_context_async().
  * @error: Return location for error or %NULL.
- * @returns: An newly allocated #IBusInputContext if the "CreateInputContext"
- *      call is suceeded, %NULL otherwise.
+ * @returns: (transfer full): An newly allocated #IBusInputContext if the
+ *      "CreateInputContext" call is suceeded, %NULL otherwise.
  *
  * Finishes an operation started with ibus_bus_create_input_context_async().
  */
index 659732b..2f8869b 100644 (file)
@@ -24,6 +24,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif
 
+#ifndef __IBUS_INPUT_CONTEXT_H_
+#define __IBUS_INPUT_CONTEXT_H_
+
 /**
  * SECTION: ibusinputcontext
  * @short_description: IBus input context proxy object.
@@ -36,9 +39,6 @@
  * Clients call the IBusInputContext to invoke BusInputContext,
  * through which invokes IBusEngine.
  */
-#ifndef __IBUS_INPUT_CONTEXT_H_
-#define __IBUS_INPUT_CONTEXT_H_
-
 #include "ibusproxy.h"
 #include "ibusenginedesc.h"
 #include "ibustext.h"
@@ -93,7 +93,6 @@ GType        ibus_input_context_get_type    (void);
  * @connection: An #GDBusConnection.
  * @cancellable: A #GCancellable or %NULL.
  * @error: Return location for error or %NULL.
- *
  * @returns: A newly allocated IBusInputContext.
  *
  * New an IBusInputContext.
@@ -125,7 +124,6 @@ void         ibus_input_context_new_async   (const gchar        *path,
  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback pass to
  *      ibus_input_context_new_async().
  * @error: Return location for error or %NULL.
- *
  * @returns: A newly allocated #IBusInputContext.
  *
  * Finishes an operation started with ibus_input_context_new_async().
@@ -169,7 +167,6 @@ void         ibus_input_context_get_input_context_async
  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback pass to
  *      ibus_input_context_get_input_context_async().
  * @error: Return location for error or %NULL.
- *
  * @returns: (transfer none): An existing #IBusInputContext.
  *
  * Finishes an operation started with ibus_input_contex_get_input_context_async().
@@ -180,7 +177,7 @@ IBusInputContext *
                                              GError            **error);
 
 /**
- * ibus_input_context_process_hand_writing_event
+ * ibus_input_context_process_hand_writing_event:
  * @context: An IBusInputContext.
  * @coordinates: An array of gdouble (0.0 to 1.0) which represents a stroke (i.e. [x1, y1, x2, y2, x3, y3, ...]).
  * @coordinates_len: The number of elements in the array. The number should be even and >= 4.
@@ -203,7 +200,7 @@ void         ibus_input_context_process_hand_writing_event
                                              guint               coordinates_len);
 
 /**
- * ibus_input_context_cancel_hand_writing
+ * ibus_input_context_cancel_hand_writing:
  * @context: An IBusInputContext.
  * @n_strokes: The number of strokes to be removed. Pass 0 to remove all.
  *
@@ -326,7 +323,7 @@ void         ibus_input_context_set_capabilities
                                              guint32             capabilities);
 
 /**
- * ibus_input_context_property_activate
+ * ibus_input_context_property_activate:
  * @context: An IBusInputContext.
  * @prop_name: A property name (e.g. "InputMode.WideLatin")
  * @state: A status of the property (e.g. PROP_STATE_CHECKED)
index 7678922..a47d887 100644 (file)
@@ -23,6 +23,9 @@
 #error "Only <ibus.h> can be included directly"
 #endif
 
+#ifndef __IBUS_PANEL_SERVICE_H_
+#define __IBUS_PANEL_SERVICE_H_
+
 /**
  * SECTION: ibuspanelservice
  * @short_description: Panel service back-end.
@@ -31,9 +34,6 @@
  * An IBusPanelService is a base class for UI services.
  * Developers can "extend" this class for panel UI development.
  */
-#ifndef __IBUS_PANEL_SERVICE_H_
-#define __IBUS_PANEL_SERVICE_H_
-
 #include "ibuslookuptable.h"
 #include "ibusservice.h"
 #include "ibusproplist.h"
@@ -131,7 +131,7 @@ GType            ibus_panel_service_get_type  (void);
 IBusPanelService *ibus_panel_service_new (GDBusConnection    *connection);
 
 /**
- * ibus_panel_service_candidate_clicked
+ * ibus_panel_service_candidate_clicked:
  * @panel: An IBusPanelService
  * @index: Index in the Lookup table
  * @button: GdkEventButton::button (1: left button, etc.)
@@ -146,7 +146,7 @@ void ibus_panel_service_candidate_clicked (IBusPanelService *panel,
                                            guint             state);
 
 /**
- * ibus_panel_service_cursor_down
+ * ibus_panel_service_cursor_down:
  * @panel: An IBusPanelService
  *
  * Notify that the cursor is down
@@ -155,7 +155,7 @@ void ibus_panel_service_candidate_clicked (IBusPanelService *panel,
 void ibus_panel_service_cursor_down       (IBusPanelService *panel);
 
 /**
- * ibus_panel_service_cursor_up
+ * ibus_panel_service_cursor_up:
  * @panel: An IBusPanelService
  *
  * Notify that the cursor is up
@@ -164,7 +164,7 @@ void ibus_panel_service_cursor_down       (IBusPanelService *panel);
 void ibus_panel_service_cursor_up         (IBusPanelService *panel);
 
 /**
- * ibus_panel_service_page_down
+ * ibus_panel_service_page_down:
  * @panel: An IBusPanelService
  *
  * Notify that the page is down
@@ -173,7 +173,7 @@ void ibus_panel_service_cursor_up         (IBusPanelService *panel);
 void ibus_panel_service_page_down         (IBusPanelService *panel);
 
 /**
- * ibus_panel_service_page_up
+ * ibus_panel_service_page_up:
  * @panel: An IBusPanelService
  *
  * Notify that the page is up
@@ -182,7 +182,7 @@ void ibus_panel_service_page_down         (IBusPanelService *panel);
 void ibus_panel_service_page_up           (IBusPanelService *panel);
 
 /**
- * ibus_panel_service_property_activate
+ * ibus_panel_service_property_activate:
  * @panel: An IBusPanelService
  * @prop_name: A property name
  * @prop_state: State of the property
@@ -194,7 +194,7 @@ void ibus_panel_service_property_activate (IBusPanelService *panel,
                                            const gchar      *prop_name,
                                            guint             prop_state);
 /**
- * ibus_panel_service_property_show
+ * ibus_panel_service_property_show:
  * @panel: An IBusPanelService
  * @prop_name: A property name
  *
@@ -205,7 +205,7 @@ void ibus_panel_service_property_show     (IBusPanelService *panel,
                                            const gchar      *prop_name);
 
 /**
- * ibus_panel_service_property_hide
+ * ibus_panel_service_property_hide:
  * @panel: An IBusPanelService
  * @prop_name: A property name
  *