[at-spi2-core] Documentation fix
- From: Patrick Welche <pwelche src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [at-spi2-core] Documentation fix
- Date: Fri, 14 Dec 2012 00:07:00 +0000 (UTC)
commit f8735e98e721a0f2a7dec001e4358fead96a2391
Author: Patrick Welche <prlw1 cam ac uk>
Date: Thu Dec 13 21:21:10 2012 +0000
Documentation fix
This change makes public that a return value of 1 from atspi_init()
means that atspi was already initialized, so testing for atspi_init()>1
makes sense as a check for errors.
atspi/atspi-constants.h | 11 ++++++-----
atspi/atspi-misc.c | 2 +-
2 files changed, 7 insertions(+), 6 deletions(-)
---
diff --git a/atspi/atspi-constants.h b/atspi/atspi-constants.h
index 7a55169..683f518 100644
--- a/atspi/atspi-constants.h
+++ b/atspi/atspi-constants.h
@@ -639,19 +639,20 @@ typedef enum {
* @ATSPI_KEY_PRESS: Emulates the pressing of a hardware keyboard key.
* @ATSPI_KEY_RELEASE: Emulates the release of a hardware keyboard key.
* @ATSPI_KEY_PRESSRELEASE: Emulates the pressing and immediate releasing
- * ofa hardware keyboard key.
+ * of a hardware keyboard key.
* @ATSPI_KEY_SYM: A symbolic key event is generated, without specifying a
* hardware key. Note: if the keysym is not present in the current keyboard
* map, the #AtspiDeviceEventController instance has a limited ability to
* generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent
* calls using out-of-keymap keysyms will vary from system to system, and on
- * the number of different out-of-keymap being generated in quick succession.
+ * the number of different out-of-keymap keysyms being generated in quick
+ * succession.
* In practice this is rarely significant, since the keysyms of interest to
* AT clients and keyboard emulators are usually part of the current keymap,
- * i.e. present on the system keyboard for the current locale (even if a
- * physical hardware keyboard is not connected.
+ * i.e., present on the system keyboard for the current locale (even if a
+ * physical hardware keyboard is not connected).
* @ATSPI_KEY_STRING: A string is converted to its equivalent keyboard events
- * and emitted. If the string consists of complex character or composed
+ * and emitted. If the string consists of complex characters or composed
* characters which are not in the current keymap, string emission is
* subject to the out-of-keymap limitations described for
* @ATSPI_KEY_SYM. In practice this limitation primarily effects
diff --git a/atspi/atspi-misc.c b/atspi/atspi-misc.c
index 548cfde..482c5fa 100644
--- a/atspi/atspi-misc.c
+++ b/atspi/atspi-misc.c
@@ -862,7 +862,7 @@ spi_display_name (void)
*
* Connects to the accessibility registry and initializes the SPI.
*
- * Returns: 0 on success, otherwise an integer error code.
+ * Returns: 0 on success, 1 if already initialized, or an integer error code.
**/
int
atspi_init (void)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]