From: Daiki Ueno Date: Tue, 14 Feb 2012 01:45:20 +0000 (+0900) Subject: Fix typoes in gtk-doc comments. X-Git-Tag: 1.4.99.20121006~89 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=3b8d6ee8fbd42a8daf3b544e8d0ba17a198a9acf;p=platform%2Fupstream%2Fibus.git Fix typoes in gtk-doc comments. BUG=none TEST=manually Review URL: https://codereview.appspot.com/5645095 --- diff --git a/src/ibusbus.h b/src/ibusbus.h index 8f78f87..7c4fdee 100644 --- a/src/ibusbus.h +++ b/src/ibusbus.h @@ -102,9 +102,9 @@ gboolean ibus_bus_is_connected (IBusBus *bus); /** * 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); @@ -112,7 +112,7 @@ GDBusConnection * /** * 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. diff --git a/src/ibusconfig.h b/src/ibusconfig.h index 07f5ce8..c3e0105 100644 --- a/src/ibusconfig.h +++ b/src/ibusconfig.h @@ -81,10 +81,10 @@ GType ibus_config_get_type (void); /** * 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, @@ -98,7 +98,7 @@ IBusConfig *ibus_config_new (GDBusConnection *connection, * 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, @@ -121,7 +121,7 @@ IBusConfig *ibus_config_new_async_finish /** * 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(). @@ -135,7 +135,7 @@ IBusConfig *ibus_config_new_async_finish * * 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, @@ -143,17 +143,17 @@ GVariant *ibus_config_get_value (IBusConfig *config, /** * 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, @@ -165,14 +165,14 @@ void ibus_config_get_value_async (IBusConfig *config, /** * 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, @@ -181,20 +181,20 @@ GVariant *ibus_config_get_value_async_finish /** * 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. @@ -203,7 +203,7 @@ GVariant *ibus_config_get_values (IBusConfig *config, * * 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, @@ -221,7 +221,7 @@ void ibus_config_get_values_async(IBusConfig *config, * * 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, @@ -230,15 +230,15 @@ GVariant *ibus_config_get_values_async_finish /** * 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, @@ -252,14 +252,14 @@ gboolean ibus_config_set_value (IBusConfig *config, * @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, @@ -272,14 +272,14 @@ void ibus_config_set_value_async (IBusConfig *config, /** * 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, @@ -288,13 +288,13 @@ gboolean ibus_config_set_value_async_finish /** * 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, diff --git a/src/ibusengine.h b/src/ibusengine.h index 9ee3462..d2d01a0 100644 --- a/src/ibusengine.h +++ b/src/ibusengine.h @@ -158,8 +158,8 @@ GType ibus_engine_get_type (void); /** * 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. * diff --git a/src/ibushotkey.h b/src/ibushotkey.h index 9a341f6..65cdc5b 100644 --- a/src/ibushotkey.h +++ b/src/ibushotkey.h @@ -156,7 +156,7 @@ gboolean ibus_hotkey_profile_remove_hotkey_by_event * * Emit a ::trigger signal when a hotkey is in a profile. * - * @see_also: ::trigger + * See also: ::trigger */ GQuark ibus_hotkey_profile_filter_key_event (IBusHotkeyProfile *profile, diff --git a/src/ibusinputcontext.h b/src/ibusinputcontext.h index be3c502..f584de3 100644 --- a/src/ibusinputcontext.h +++ b/src/ibusinputcontext.h @@ -283,7 +283,7 @@ gboolean ibus_input_context_process_key_event_async_finish * * 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, @@ -333,7 +333,7 @@ void ibus_input_context_set_capabilities * * Activate the property asynchronously. * - * @see_also: #IBusEngine::property_activate + * See also: #IBusEngine::property_activate */ void ibus_input_context_property_activate (IBusInputContext *context, diff --git a/src/ibusserializable.h b/src/ibusserializable.h index 7a100c2..742aeb6 100644 --- a/src/ibusserializable.h +++ b/src/ibusserializable.h @@ -29,8 +29,8 @@ * @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: @@ -85,10 +85,10 @@ /** * 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) \ @@ -96,10 +96,10 @@ /** * 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) \ @@ -131,7 +131,7 @@ struct _IBusSerializable { * @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. */ @@ -145,7 +145,7 @@ typedef gboolean (* IBusSerializableSerializeFunc) (IBusSerializable * @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. */ @@ -155,7 +155,7 @@ typedef gint (* IBusSerializableDeserializeFunc) (IBusSerializable /** * IBusSerializableCopyFunc: * @dest: The destination #IBusSerializable. - * @src: A source #IBusMessageIter. + * @src: A source #IBusSerializable. * @returns: %TRUE if succeed; %FALSE otherwise. * * Prototype of copy function. @@ -197,10 +197,10 @@ IBusSerializable *ibus_serializable_new (void); * @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, @@ -213,7 +213,7 @@ void ibus_serializable_set_qattachment (IBusSerializable *ser * @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); @@ -224,7 +224,7 @@ GVariant *ibus_serializable_get_qattachment (IBusSerializable *ser * @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, @@ -238,7 +238,7 @@ void ibus_serializable_remove_qattachment * Clone an #IBusSerializable. * The copy method should be implemented in extended class. * - * @see_also: IBusSerializableCopyFunc(). + * See also: IBusSerializableCopyFunc(). */ IBusSerializable *ibus_serializable_copy (IBusSerializable *serializable); @@ -250,7 +250,7 @@ IBusSerializable *ibus_serializable_copy (IBusSerializable *ser * 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); @@ -262,7 +262,7 @@ GVariant *ibus_serializable_serialize (IBusSerializable *ser * 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); diff --git a/src/ibusshare.h b/src/ibusshare.h index d1cf237..61db3cd 100644 --- a/src/ibusshare.h +++ b/src/ibusshare.h @@ -188,7 +188,7 @@ void ibus_set_display (const gchar *display); * Socket file under ~/.config/ibus/bus/ * * - * @see_also: ibus_write_address(). + * See also: ibus_write_address(). */ const gchar *ibus_get_address (void); @@ -198,7 +198,7 @@ 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); @@ -302,7 +302,7 @@ void ibus_init (void); * * 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); @@ -312,7 +312,7 @@ 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); @@ -325,7 +325,7 @@ 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