[at-spi2-core] Fix GTK-Doc comment blocks
- From: Mike Gorse <mgorse src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [at-spi2-core] Fix GTK-Doc comment blocks
- Date: Mon, 23 Mar 2015 23:27:47 +0000 (UTC)
commit 898de723a8c6ad09605bf21b821432978bbf18c1
Author: Dieter Verfaillie <dieterv optionexplicit be>
Date: Mon Sep 2 17:26:18 2013 +0200
Fix GTK-Doc comment blocks
https://bugs.freedesktop.org/show_bug.cgi?id=89678
atspi/atspi-component.c | 8 ++++----
atspi/atspi-constants.h | 4 ++--
atspi/atspi-misc.c | 32 ++++++++++++++++----------------
3 files changed, 22 insertions(+), 22 deletions(-)
---
diff --git a/atspi/atspi-component.c b/atspi/atspi-component.c
index a375567..0ab552b 100644
--- a/atspi/atspi-component.c
+++ b/atspi/atspi-component.c
@@ -362,9 +362,9 @@ atspi_component_set_extents (AtspiComponent *obj,
* @ctype: the coordinate system in which the position is specified.
* (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
*
- * Returns: #TRUE if successful; #FALSE otherwise.
- *
* Moves the component to the specified position.
+ *
+ * Returns: #TRUE if successful; #FALSE otherwise.
**/
gboolean
atspi_component_set_position (AtspiComponent *obj,
@@ -391,9 +391,9 @@ atspi_component_set_position (AtspiComponent *obj,
* @width: the width to which the component should be resized.
* @height: the height to which the component should be resized.
*
- * Returns: #TRUE if successful; #FALSE otherwise.
- *
* Resizes the specified component to the given coordinates.
+ *
+ * Returns: #TRUE if successful; #FALSE otherwise.
**/
gboolean
atspi_component_set_size (AtspiComponent *obj,
diff --git a/atspi/atspi-constants.h b/atspi/atspi-constants.h
index 6095fb4..838adc7 100644
--- a/atspi/atspi-constants.h
+++ b/atspi/atspi-constants.h
@@ -1120,9 +1120,9 @@ typedef enum {
* particular application.
* @ATSPI_ROLE_INFO_BAR: An object designed to present a message to the user
* within an existing window.
- * ATSPI_ROLE_LEVEL_BAR: A bar that serves as a level indicator to, for
+ * @ATSPI_ROLE_LEVEL_BAR: A bar that serves as a level indicator to, for
* instance, show the strength of a password or the state of a battery.
- * Since: 2.8
+ * Since: 2.8
* ATSPI_ROLE_TITLE_BAR: A bar that serves as the title of a window or a
* dialog. @Since: 2.12
* ATSPI_ROLE_BLOCK_QUOTE: An object which contains a text section
diff --git a/atspi/atspi-misc.c b/atspi/atspi-misc.c
index 3404873..4cf7732 100644
--- a/atspi/atspi-misc.c
+++ b/atspi/atspi-misc.c
@@ -1586,23 +1586,23 @@ atspi_get_a11y_bus (void)
/**
* atspi_set_timeout:
- * @val: The timeout value, in milliseconds, or -1 to disable the timeout.
- * @startup_time: The amount of time, in milliseconds, to allow to pass
- * before enforcing timeouts on an application. Can be used to prevent
- * timeout exceptions if an application is likely to block for an extended
- * period of time on initialization. -1 can be passed to disable this
- * behavior.
+ * @val: The timeout value, in milliseconds, or -1 to disable the timeout.
+ * @startup_time: The amount of time, in milliseconds, to allow to pass
+ * before enforcing timeouts on an application. Can be used to prevent
+ * timeout exceptions if an application is likely to block for an extended
+ * period of time on initialization. -1 can be passed to disable this
+ * behavior.
*
- * Set the timeout used for method calls. If this is not set explicitly,
- * a default of 0.8 ms is used.
- * Note that at-spi2-registryd currently uses a timeout of 3 seconds when
- * sending a keyboard event notification. This means that, if an AT makes
- * a call in response to the keyboard notification and the application
- * being called does not respond before the timeout is reached,
- * at-spi2-registryd will time out on the keyboard event notification and
- * pass the key onto the application (ie, reply to indicate that the key
- * was not consumed), so this may make it undesirable to set a timeout
- * larger than 3 seconds.
+ * Set the timeout used for method calls. If this is not set explicitly,
+ * a default of 0.8 ms is used.
+ * Note that at-spi2-registryd currently uses a timeout of 3 seconds when
+ * sending a keyboard event notification. This means that, if an AT makes
+ * a call in response to the keyboard notification and the application
+ * being called does not respond before the timeout is reached,
+ * at-spi2-registryd will time out on the keyboard event notification and
+ * pass the key onto the application (ie, reply to indicate that the key
+ * was not consumed), so this may make it undesirable to set a timeout
+ * larger than 3 seconds.
*
* By default, the normal timeout is set to 800 ms, and the application startup
* timeout is set to 15 seconds.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]