Fix typoes in gtk-doc comments.

[platform/upstream/ibus.git] / src / ibusconfig.h

diff --git a/src/ibusconfig.h b/src/ibusconfig.h
index 07f5ce8..c3e0105 100644 (file)
--- 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,