/**
* ibus_bus_get_connection:
* @bus: An #IBusBus.
- * @returns: (transfer none): A #GDBusConnection of an #IBusIBus instance.
+ * @returns: (transfer none): A #GDBusConnection of an #IBusBus instance.
*
- * Return #GDBusConnection of an #IBusIBus instance.
+ * Return #GDBusConnection of an #IBusBus instance.
*/
GDBusConnection *
ibus_bus_get_connection (IBusBus *bus);
/**
* ibus_bus_hello:
* @bus: An #IBusBus.
- * @returns: The unique name of #IBus process in DBus.
+ * @returns: The unique name of IBus process in DBus.
*
* This function sends a "HELLO" message to DBus daemon,
* which replies the unique name of current IBus process.
/**
* ibus_config_new:
- * @connection: An GDBusConnection.
- * @returns: An newly allocated IBusConfig corresponding to @connection.
+ * @connection: A #GDBusConnection.
+ * @returns: An newly allocated #IBusConfig corresponding to @connection.
*
- * New an #IBusConfig from existing GDBusConnection.
+ * New an #IBusConfig from existing #GDBusConnection.
*/
IBusConfig *ibus_config_new (GDBusConnection *connection,
GCancellable *cancellable,
* The callback should not be %NULL.
* @user_data: The data to pass to callback.
*
- * New an #IBusContext asynchronously.
+ * New an #IBusConfig asynchronously.
*/
void ibus_config_new_async (GDBusConnection *connection,
GCancellable *cancellable,
/**
* ibus_config_get_value:
- * @config: An IBusConfig
+ * @config: An #IBusConfig
* @section: Section name of the configuration option.
* @name: Name of the configure option.
* @returns: A #GVariant or %NULL. Free with g_variant_unref().
*
* ibus-chewing, for example, stores its setting in /desktop/ibus/engine/Chewing,
* so the section name for it is "engine/Chewing".
- * @see_also: ibus_config_set_value.
+ * See also: ibus_config_set_value().
*/
GVariant *ibus_config_get_value (IBusConfig *config,
const gchar *section,
/**
* ibus_config_get_value_async:
- * @config: An IBusConfig
+ * @config: An #IBusConfig
* @section: Section name of the configuration option.
* @name: Name of the configure option.
- * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
+ * @timeout_ms: The timeout in milliseconds or -1 to use the default timeout.
* @cancellable: A #GCancellable or %NULL.
* @callback: Callback function to invoke when the return value is ready.
* @user_data: The data to pass to callback.
*
* Get the value of a configuration option asynchronously.
*
- * @see_also: ibus_config_get_value.
+ * See also: ibus_config_get_value().
*/
void ibus_config_get_value_async (IBusConfig *config,
const gchar *section,
/**
* ibus_config_get_value_async_finish:
- * @confi: A #IBusConfig.
+ * @config: A #IBusConfig.
* @result: A #GAsyncResult.
* @error: Return location for error or %NULL.
* @returns: A #GVariant or %NULL if error is set. Free with g_variant_unref().
*
* Finish get value of a configuration option.
*
- * @see_also: ibus_config_get_value_async.
+ * See also: ibus_config_get_value_async().
*/
GVariant *ibus_config_get_value_async_finish
(IBusConfig *config,
/**
* ibus_config_get_values:
- * @config: An IBusConfig
+ * @config: An #IBusConfig
* @section: Section name of the configuration option.
* @returns: A #GVariant or %NULL. Free with g_variant_unref().
*
* Get all values in a section synchronously.
*
- * @see_also: ibus_config_set_value.
+ * See also: ibus_config_set_value().
*/
GVariant *ibus_config_get_values (IBusConfig *config,
const gchar *section);
/**
* ibus_config_get_values_async:
- * @config: An IBusConfig
+ * @config: An #IBusConfig
* @section: Section name of the configuration option.
* @timeout_ms: The timeout in milliseconds or -1 to use the default timeout.
* @cancellable: A #GCancellable or %NULL.
*
* Get all values in a section asynchronously.
*
- * @see_also: ibus_config_get_values.
+ * See also: ibus_config_get_values().
*/
void ibus_config_get_values_async(IBusConfig *config,
const gchar *section,
*
* Finish get values in a section.
*
- * @see_also: ibus_config_get_values_async.
+ * See also: ibus_config_get_values_async().
*/
GVariant *ibus_config_get_values_async_finish
(IBusConfig *config,
/**
* ibus_config_set_value:
- * @config: An IBusConfig
+ * @config: An #IBusConfig
* @section: Section name of the configuration option.
* @name: Name of the configure option its self.
* @value: A #GVariant that holds the value. If the value is floating, the
* function takes ownership of it.
- * @returns: TRUE if succeed; FALSE otherwise.
+ * @returns: %TRUE if succeed; %FALSE otherwise.
*
* Set the value of a configuration option synchronously.
- * @see_also: ibus_config_get_value.
+ * See also: ibus_config_get_value().
*/
gboolean ibus_config_set_value (IBusConfig *config,
const gchar *section,
* @name: Name of the configure option.
* @value: A #GVariant that holds the value. If the value is floating, the
* function takes ownership of it.
- * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
+ * @timeout_ms: The timeout in milliseconds or -1 to use the default timeout.
* @cancellable: A #GCancellable or %NULL.
* @callback: Callback function to invoke when the return value is ready.
* @user_data: The data to pass to callback.
*
* Set the value of a configuration option asynchronously.
*
- * @see_also: ibus_config_set_value.
+ * See also: ibus_config_set_value().
*/
void ibus_config_set_value_async (IBusConfig *config,
const gchar *section,
/**
* ibus_config_set_value_async_finish:
- * @confi: A #IBusConfig.
+ * @config: A #IBusConfig.
* @result: A #GAsyncResult.
* @error: Return location for error or %NULL.
* @returns: %TRUE or %FALSE if error is set.
*
* Finish set value of a configuration option.
*
- * @see_also: ibus_config_set_value_async.
+ * See also: ibus_config_set_value_async().
*/
gboolean ibus_config_set_value_async_finish
(IBusConfig *config,
/**
* ibus_config_unset:
- * @config: An IBusConfig
+ * @config: An #IBusConfig
* @section: Section name of the configuration option.
* @name: Name of the configure option its self.
- * @returns: TRUE if succeed; FALSE otherwise.
+ * @returns: %TRUE if succeed; %FALSE otherwise.
*
* Remove an entry of a configuration option.
- * @see_also: ibus_config_get_value.
+ * See also: ibus_config_get_value().
*/
gboolean ibus_config_unset (IBusConfig *config,
const gchar *section,
/**
* ibus_engine_new:
- * @name: Name of the IBusObject.
- * @path: Path for IBusService.
+ * @engine_name: Name of the IBusObject.
+ * @object_path: Path for IBusService.
* @connection: An opened GDBusConnection.
* @returns: A newly allocated IBusEngine.
*
*
* Emit a <constant>::trigger</constant> signal when a hotkey is in a profile.
*
- * @see_also: ::trigger
+ * See also: ::trigger
*/
GQuark ibus_hotkey_profile_filter_key_event
(IBusHotkeyProfile *profile,
*
* Pass the key event to input method engine and wait for the reply from ibus (i.e. synchronous IPC).
*
- * @see_also: ibus_input_context_process_key_event_async()
+ * See also: ibus_input_context_process_key_event_async()
*/
gboolean ibus_input_context_process_key_event
(IBusInputContext *context,
*
* Activate the property asynchronously.
*
- * @see_also: #IBusEngine::property_activate
+ * See also: #IBusEngine::property_activate
*/
void ibus_input_context_property_activate
(IBusInputContext *context,
* @short_description: A serializable object.
* @stability: Stable
*
- * An IBusSerializable is an IBus object which can be serialized, that is,
- * to be to and from an IBusMessage.
+ * An #IBusSerializable is an IBus object which can be serialized, that is,
+ * to be to and from a #GVariant.
*
* This class is to be extended by other class that requires serialization.
* An extended class should overrides following methods:
/**
* ibus_serializable_get_attachment:
- * @o: An IBusSerializable.
+ * @o: An #IBusSerializable.
* @k: String formatted key for indexing value.
*
- * Get a value from attachment of an IBusSerializable.
+ * Get a value from attachment of an #IBusSerializable.
* This macro is an convenient wrapper of ibus_serializable_get_qattachment().
*/
#define ibus_serializable_get_attachment(o, k) \
/**
* ibus_serializable_remove_attachment:
- * @o: An IBusSerializable.
+ * @o: An #IBusSerializable.
* @k: String formatted key for indexing value.
*
- * Remove a value from attachment of an IBusSerializable.
+ * Remove a value from attachment of an #IBusSerializable.
* This macro is an convenient wrapper of ibus_serializable_remove_qattachment().
*/
#define ibus_serializable_remove_attachment(o, k) \
* @returns: %TRUE if succeed; %FALSE otherwise.
*
* Prototype of serialize function.
- * Serialize function convert an IBusSerializable to IBusMessageIter.
+ * Serialize function convert an #IBusSerializable to #GVariantBuilder.
* Returns a gboolean value which indicates whether the conversion is success.
* Return %TRUE if succeed.
*/
* @returns: The number of values in the variant(tuple) are consumed.
*
* Prototype of deserialize function.
- * Deserialize function convert an IBusMessageIter to IBusSerializable.
+ * Deserialize function convert a #GVariant to #IBusSerializable.
* Returns an integer value which indicates how many values in
* the variant(tuple) are consumed.
*/
/**
* IBusSerializableCopyFunc:
* @dest: The destination #IBusSerializable.
- * @src: A source #IBusMessageIter.
+ * @src: A source #IBusSerializable.
* @returns: %TRUE if succeed; %FALSE otherwise.
*
* Prototype of copy function.
* @key: String formatted key for indexing value.
* @value: Value to be attached or %NULL to remove any prevoius value.
*
- * Attach a value to an IBusSerializable. If the value is floating,
+ * Attach a value to an #IBusSerializable. If the value is floating,
* the serializable will take the ownership.
*
- * @see_also: ibus_serializable_set_attachment().
+ * See also: ibus_serializable_set_attachment().
*/
void ibus_serializable_set_qattachment (IBusSerializable *serializable,
GQuark key,
* @returns: The attached value; or %NULL if fail to retrieve the value.
*
* Get a value from attachment of an #IBusSerializable.
- * @see_also: ibus_serializable_set_attachment().
+ * See also: ibus_serializable_set_attachment().
*/
GVariant *ibus_serializable_get_qattachment (IBusSerializable *serializable,
GQuark key);
* @key: String formatted key for indexing value.
*
* Remove a value from attachment of an #IBusSerializable.
- * @see_also: ibus_serializable_remove_attachment().
+ * See also: ibus_serializable_remove_attachment().
*/
void ibus_serializable_remove_qattachment
(IBusSerializable *serializable,
* Clone an #IBusSerializable.
* The copy method should be implemented in extended class.
*
- * @see_also: IBusSerializableCopyFunc().
+ * See also: IBusSerializableCopyFunc().
*/
IBusSerializable *ibus_serializable_copy (IBusSerializable *serializable);
* Serialize an #IBusSerializable to a #GVariant.
* The serialize method should be implemented in extended class.
*
- * @see_also: IBusSerializableCopyFunc().
+ * See also: IBusSerializableCopyFunc().
*/
GVariant *ibus_serializable_serialize (IBusSerializable *serializable);
* Deserialize a #GVariant to an #IBusSerializable/
* The deserialize method should be implemented in extended class.
*
- * @see_also: IBusSerializableCopyFunc().
+ * See also: IBusSerializableCopyFunc().
*/
IBusSerializable *ibus_serializable_deserialize (GVariant *variant);
* <listitem><para>Socket file under ~/.config/ibus/bus/</para></listitem>
* </orderedlist>
*
- * @see_also: ibus_write_address().
+ * See also: ibus_write_address().
*/
const gchar *ibus_get_address (void);
*
* Write D-Bus address to socket file.
*
- * @see_also: ibus_get_address().
+ * See also: ibus_get_address().
*/
void ibus_write_address (const gchar *address);
*
* Runs an IBus main loop until ibus_quit() is called in the loop.
*
- * @see_also: ibus_quit().
+ * See also: ibus_quit().
*/
void ibus_main (void);
* Stops an IBus from running.
*
* Any calls to ibus_quit() for the loop will return.
- * @see_also: ibus_main().
+ * See also: ibus_main().
*/
void ibus_quit (void);
*
* (ibus-daemon:7088): IBUS-DEBUG: 18:06:45.822819: ibus-daemon started
*
- * If @verbose is TRUE, all levels of messages will be logged. Otherwise,
+ * If @verbose is %TRUE, all levels of messages will be logged. Otherwise,
* DEBUG and WARNING messages will be ignored. The function is used in
* ibus-daemon, but can be useful for IBus client programs as well for
* debugging. It's totally fine for not calling this function. If you
projects / platform / upstream / ibus.git / commitdiff