From 72b43d5ed6c0c55a344d7f201936b81c38dee2b6 Mon Sep 17 00:00:00 2001 From: Chris Bradfield Date: Sun, 6 Oct 2019 16:26:15 -0700 Subject: [PATCH] [DOC] Fill in various missing method/member descriptions. --- doc/classes/Camera2D.xml | 7 +++++++ doc/classes/CameraFeed.xml | 8 +++++--- doc/classes/ColorPicker.xml | 2 ++ doc/classes/Input.xml | 1 + doc/classes/VideoPlayer.xml | 1 + 5 files changed, 16 insertions(+), 3 deletions(-) diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index aeeebdf00d9..6f1627e296d 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -51,6 +51,7 @@ + Returns the specified margin. See also [member drag_margin_bottom], [member drag_margin_top], [member drag_margin_left], and [member drag_margin_right]. @@ -59,6 +60,7 @@ + Returns the specified camera limit. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right]. @@ -84,6 +86,7 @@ + Sets the specified margin. See also [member drag_margin_bottom], [member drag_margin_top], [member drag_margin_left], and [member drag_margin_right]. @@ -94,6 +97,7 @@ + Sets the specified camera limit. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right]. @@ -161,6 +165,7 @@ [b]Note:[/b] Used the same as [member offset_h]. + The camera's process callback. See [enum Camera2DProcessMode]. If [code]true[/code], the camera rotates with the target. @@ -183,8 +188,10 @@ The camera's position takes into account vertical/horizontal offsets and the screen size. + The camera updates with the [code]_physics_process[/code] callback. + The camera updates with the [code]_process[/code] callback. diff --git a/doc/classes/CameraFeed.xml b/doc/classes/CameraFeed.xml index 6d7757f9f58..f490faf3697 100644 --- a/doc/classes/CameraFeed.xml +++ b/doc/classes/CameraFeed.xml @@ -14,28 +14,30 @@ - Gets the unique ID for this feed. + Returns the unique ID for this feed. - Gets the camera's name. + Returns the camera's name. - Position of camera on the device. + Returns the position of camera on the device. + If [code]true[/code], the feed is active. + The transform applied to the camera's image. diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index cd36f4fdf0a..07ce76fdb21 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -51,8 +51,10 @@ [b]Note:[/b] Cannot be enabled if raw mode is on. + If [code]true[/code], the "add preset" button is enabled. + If [code]true[/code], saved color presets are visible. If [code]true[/code], allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR). diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index afb39778499..6d4adfad518 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -71,6 +71,7 @@ + Returns the currently assigned cursor shape (see [enum CursorShape]). diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index 18a85d496f4..2215f26c237 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -65,6 +65,7 @@ If [code]true[/code], the video is paused. + The assigned video stream. See description for supported formats. The current position of the stream, in seconds.