From 471271b727fd1dcc716a10f34e615ce61ca6d16e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 9 Mar 2020 10:12:53 +0100 Subject: [PATCH] doc: Sync classref with current source --- doc/classes/InputEventKey.xml | 6 +++--- doc/classes/OS.xml | 34 +++++++++++++++++----------------- doc/classes/Rect2.xml | 2 +- doc/classes/Semaphore.xml | 14 +++++++------- 4 files changed, 28 insertions(+), 28 deletions(-) diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 42ac7e58d95..c8d0769b90c 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -31,9 +31,6 @@ If [code]true[/code], the key was already pressed before this event. It means the user is holding the key down. - - If [code]true[/code], the key's state is pressed. If [code]false[/code], the key's state is released. - The key keycode, which corresponds to one of the [enum KeyList] constants. Represent key in the current keyboard layout. To get a human-readable representation of the [InputEventKey], use [code]OS.get_keycode_string(event.keycode)[/code] where [code]event[/code] is the [InputEventKey]. @@ -42,6 +39,9 @@ Key physical keycode, which corresponds to one of the [enum KeyList] constants. Represent the physical location of a key on the 101/102-key US QWERTY keyboard. To get a human-readable representation of the [InputEventKey], use [code]OS.get_keycode_string(event.keycode)[/code] where [code]event[/code] is the [InputEventKey]. + + If [code]true[/code], the key's state is pressed. If [code]false[/code], the key's state is released. + The key Unicode identifier (when relevant). Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See [method OS.set_ime_active] for more information. diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 6d950a4175d..d43c395433f 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -242,6 +242,16 @@ [b]Note:[/b] This method is implemented on macOS. + + + + + + + Returns the given keycode as a string (e.g. Return values: [code]"Escape"[/code], [code]"Shift+Escape"[/code]). + See also [member InputEventKey.keycode] and [method InputEventKey.get_keycode_with_modifiers]. + + @@ -295,16 +305,6 @@ Returns the window size including decorations like window borders. - - - - - - - Returns the given keycode as a string (e.g. Return values: [code]"Escape"[/code], [code]"Shift+Escape"[/code]). - See also [member InputEventKey.keycode] and [method InputEventKey.get_keycode_with_modifiers]. - - @@ -588,13 +588,6 @@ To check whether the Godot binary used to run the project is an export template (debug or release), use [code]OS.has_feature("standalone")[/code] instead. - - - - - Returns [code]true[/code] if the [b]OK[/b] button should appear on the left and [b]Cancel[/b] on the right. - - @@ -604,6 +597,13 @@ Returns [code]true[/code] if the input keycode corresponds to a Unicode character. + + + + + Returns [code]true[/code] if the [b]OK[/b] button should appear on the left and [b]Cancel[/b] on the right. + + diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index dbf461cdf15..5bc55c9ce3c 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -143,7 +143,7 @@ - + Returns [code]true[/code] if the [Rect2] overlaps with [code]b[/code] (i.e. they have at least one point in common). diff --git a/doc/classes/Semaphore.xml b/doc/classes/Semaphore.xml index 19719eea93a..c9745acfcd7 100644 --- a/doc/classes/Semaphore.xml +++ b/doc/classes/Semaphore.xml @@ -17,13 +17,6 @@ Lowers the [Semaphore], allowing one more thread in. - - - - - Waits for the [Semaphore], if its value is zero, blocks until non-zero. - - @@ -31,6 +24,13 @@ Like [method wait], but won't block, so if the value is zero, fails immediately and returns [constant ERR_BUSY]. If non-zero, it returns [constant OK] to report success. + + + + + Waits for the [Semaphore], if its value is zero, blocks until non-zero. + +