From 624a2b08f362d0ec74cd617890b1a4c9de6b0d96 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Thu, 7 Dec 2017 08:29:38 +0100 Subject: [PATCH] doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc --- doc/classes/AudioStreamSample.xml | 17 +- doc/classes/BitMap.xml | 7 - doc/classes/BitmapFont.xml | 9 - doc/classes/Curve.xml | 2 - doc/classes/Curve2D.xml | 3 - doc/classes/Curve3D.xml | 2 - doc/classes/GIProbeData.xml | 178 +++++++++++++++--- doc/classes/ItemList.xml | 2 - doc/classes/LargeTexture.xml | 8 - doc/classes/MenuButton.xml | 4 - doc/classes/MultiMesh.xml | 4 - doc/classes/NavigationMesh.xml | 18 +- doc/classes/NavigationPolygon.xml | 22 ++- doc/classes/Node.xml | 18 +- doc/classes/Node2D.xml | 17 +- doc/classes/OptionButton.xml | 2 - doc/classes/PolygonPathFinder.xml | 4 - doc/classes/PopupMenu.xml | 2 - doc/classes/ResourcePreloader.xml | 4 - doc/classes/Shader.xml | 18 +- doc/classes/SpriteFrames.xml | 3 - doc/classes/Translation.xml | 2 - .../doc_classes/AudioStreamOGGVorbis.xml | 53 ++++-- .../theora/doc_classes/VideoStreamTheora.xml | 18 +- .../doc_classes/VisualScript.xml | 4 - .../doc_classes/VisualScriptConstructor.xml | 52 ++--- .../doc_classes/VisualScriptDeconstruct.xml | 2 - .../doc_classes/VisualScriptFunctionCall.xml | 2 - .../doc_classes/VisualScriptNode.xml | 4 - .../doc_classes/VisualScriptPropertyGet.xml | 2 - .../doc_classes/VisualScriptPropertySet.xml | 2 - .../doc_classes/VisualScriptYield.xml | 16 +- modules/webm/doc_classes/VideoStreamWebm.xml | 18 +- 33 files changed, 350 insertions(+), 169 deletions(-) diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index ac8cc7a445a..83e9729bc16 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -11,11 +11,22 @@ + + + + + + + + + + + + + + - - Raw audio data. - Audio format. See FORMAT_* constants for values. diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index 9e2cd616f21..39bf46ac3d5 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -75,13 +75,6 @@ - - - Returns a [Dictionary] with two keys : - [code]data[/code] : [PoolByteArray] with [code]true[/code]/[code]false[/code] [code]BitMap[/code] data. - [code]size[/code] : The [code]Bitmap[/code]'s size. - - diff --git a/doc/classes/BitmapFont.xml b/doc/classes/BitmapFont.xml index 6d98c5e629b..2fb7d7d87ad 100644 --- a/doc/classes/BitmapFont.xml +++ b/doc/classes/BitmapFont.xml @@ -109,9 +109,6 @@ Ascent (number of pixels above the baseline). - - The characters in the BitmapFont. - If [code]true[/code] distance field hint is enabled. @@ -121,12 +118,6 @@ Total font height (ascent plus descent) in pixels. - - The font's kernings as [PoolIntArray]. - - - The font's [Texture]s. - diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml index 4c9ced63c82..3e1158ca3b7 100644 --- a/doc/classes/Curve.xml +++ b/doc/classes/Curve.xml @@ -169,8 +169,6 @@ - - diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index 8b86359cc5b..8a857799e61 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -175,9 +175,6 @@ - - The points describing the curve. Value is a [Dictionary] with the keys [code]in[/code], [code]out[/code], and [code]pos[/code]. The key pos is the position of a vertex of the curve, the key in is the vector from that position to the control point before this vertex, the key out is the vector from that position to the controlpoint after this vertex. - The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index c758e1d9dad..e30ae856175 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -202,8 +202,6 @@ - - diff --git a/doc/classes/GIProbeData.xml b/doc/classes/GIProbeData.xml index 2ac591889c2..aba59f57eac 100644 --- a/doc/classes/GIProbeData.xml +++ b/doc/classes/GIProbeData.xml @@ -9,31 +9,161 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index d10722d411b..f3d0c271ac6 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -332,8 +332,6 @@ - - diff --git a/doc/classes/LargeTexture.xml b/doc/classes/LargeTexture.xml index 3899254e9d9..9d79034deaa 100644 --- a/doc/classes/LargeTexture.xml +++ b/doc/classes/LargeTexture.xml @@ -87,14 +87,6 @@ - - - Returns an [Array] with offsets and textures data of each added piece. Schema is [offsets1, texture1, offsets2, texture2, large_texture_size]. - [code]offsets[/code] : [Vector2] offsets of the texture piece. - [code]second[/code] : [StreamTexture] data of the texture piece. - [code]last entry[/code] : [Vector2] size of the entire large texture. - - diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index 6f41f844850..c41c86d6934 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -19,10 +19,6 @@ - - - - diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index ae26641596b..ff2d89b2ca7 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -63,16 +63,12 @@ - - - - diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index 5563c94b354..55a3771d795 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -45,6 +45,20 @@ + + + + + + + + + + + + + + @@ -75,16 +89,12 @@ - - - - diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index 585566dbf94..663ac4cd67b 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -75,6 +75,12 @@ + + + + + + @@ -99,15 +105,15 @@ + + + + + + + + - - - - - - - - diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 13a25fa48f2..e2198c3e15b 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -350,6 +350,12 @@ Returns [code]true[/code] if the "node" argument is a direct or indirect child of the current node, otherwise return [code]false[code]. + + + + + + @@ -641,6 +647,14 @@ Remotely changes property's value on a specific peer identified by [i]peer_id[/i] using an unreliable protocol. + + + + + + + + @@ -750,10 +764,6 @@ - - - - diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 112960d9f83..81978809d7e 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -38,6 +38,12 @@ Returns the [Transform2D] relative to this node's parent. + + + + + + @@ -87,6 +93,14 @@ Applies a rotation to the node, in radians, starting from its current rotation. + + + + + + + + @@ -134,9 +148,6 @@ Position, relative to the node's parent. - - Rotation in radians, relative to the node's parent. - Rotation in degrees, relative to the node's parent. diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 5f1b6f328cc..76265e700a7 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -183,8 +183,6 @@ - - diff --git a/doc/classes/PolygonPathFinder.xml b/doc/classes/PolygonPathFinder.xml index 58c14cc9201..48c5625e6b4 100644 --- a/doc/classes/PolygonPathFinder.xml +++ b/doc/classes/PolygonPathFinder.xml @@ -80,10 +80,6 @@ - - - - diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 6b36ff9eee5..7071d64f2e8 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -423,8 +423,6 @@ - - diff --git a/doc/classes/ResourcePreloader.xml b/doc/classes/ResourcePreloader.xml index 1766845bf22..c749529a195 100644 --- a/doc/classes/ResourcePreloader.xml +++ b/doc/classes/ResourcePreloader.xml @@ -67,10 +67,6 @@ - - - - diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml index 543164d92e5..082c48dfceb 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -11,6 +11,12 @@ + + + + + + @@ -33,6 +39,14 @@ + + + + + + + + @@ -44,10 +58,6 @@ - - - - diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index 01573865730..883a6d4fa8c 100644 --- a/doc/classes/SpriteFrames.xml +++ b/doc/classes/SpriteFrames.xml @@ -164,9 +164,6 @@ - - An [Array] containing the [code]name[/code], [code]speed[/code], [code]loop[/code], and [code]frames[/code] of each animation. - diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml index a684e63e225..cb49c663836 100644 --- a/doc/classes/Translation.xml +++ b/doc/classes/Translation.xml @@ -57,8 +57,6 @@ - - diff --git a/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml b/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml index c0f8c6b9c76..4533d59cae3 100644 --- a/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml +++ b/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml @@ -11,18 +11,49 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - Raw audio data. - - - If [code]true[/code], audio will loop continuously. Default value: [code]false[/code]. - - - If loop is [code]true[/code], loop starts from this position, in seconds. - - diff --git a/modules/theora/doc_classes/VideoStreamTheora.xml b/modules/theora/doc_classes/VideoStreamTheora.xml index 61884f47fa9..6c8806ed729 100644 --- a/modules/theora/doc_classes/VideoStreamTheora.xml +++ b/modules/theora/doc_classes/VideoStreamTheora.xml @@ -9,11 +9,21 @@ + + + + + + + + + + + + + + - - - - diff --git a/modules/visual_script/doc_classes/VisualScript.xml b/modules/visual_script/doc_classes/VisualScript.xml index cc55b72ec7b..46bd35dd734 100644 --- a/modules/visual_script/doc_classes/VisualScript.xml +++ b/modules/visual_script/doc_classes/VisualScript.xml @@ -495,10 +495,6 @@ - - - - diff --git a/modules/visual_script/doc_classes/VisualScriptConstructor.xml b/modules/visual_script/doc_classes/VisualScriptConstructor.xml index f3c6b6a304f..cbe8c6c096c 100644 --- a/modules/visual_script/doc_classes/VisualScriptConstructor.xml +++ b/modules/visual_script/doc_classes/VisualScriptConstructor.xml @@ -11,31 +11,35 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - The constructor function's method info. Has roughly the following structure: - [codeblock] - { - name = "string", - args = [{ - name = "string" - class_name = "string" - type = TYPE_* - hint = PROPERTY_HINT_* - hint_string = "string" - }] - default_args = [] # Array of variants - flags = METHOD_FLAG_* - id = 0 - return = {type = TYPE_*} - } - [/codeblock] - - - The type to be constructed. - - diff --git a/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml b/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml index 86cf4410ac4..0f396564e23 100644 --- a/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml +++ b/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml @@ -13,8 +13,6 @@ - - The type to deconstruct. diff --git a/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml b/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml index cc2360fc2e2..03c47dca7cb 100644 --- a/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml +++ b/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml @@ -11,8 +11,6 @@ - - diff --git a/modules/visual_script/doc_classes/VisualScriptNode.xml b/modules/visual_script/doc_classes/VisualScriptNode.xml index 94fed449506..ef7cf7c3b88 100644 --- a/modules/visual_script/doc_classes/VisualScriptNode.xml +++ b/modules/visual_script/doc_classes/VisualScriptNode.xml @@ -46,10 +46,6 @@ - - - - diff --git a/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml b/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml index f68f0edeeae..11c50f2b975 100644 --- a/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml +++ b/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml @@ -25,8 +25,6 @@ - - diff --git a/modules/visual_script/doc_classes/VisualScriptPropertySet.xml b/modules/visual_script/doc_classes/VisualScriptPropertySet.xml index d4305af57f1..2e96ccc1f60 100644 --- a/modules/visual_script/doc_classes/VisualScriptPropertySet.xml +++ b/modules/visual_script/doc_classes/VisualScriptPropertySet.xml @@ -27,8 +27,6 @@ - - diff --git a/modules/visual_script/doc_classes/VisualScriptYield.xml b/modules/visual_script/doc_classes/VisualScriptYield.xml index b42fc027cfa..72ef586c1fc 100644 --- a/modules/visual_script/doc_classes/VisualScriptYield.xml +++ b/modules/visual_script/doc_classes/VisualScriptYield.xml @@ -9,10 +9,22 @@ + + + + + + + + + + + + + + - - diff --git a/modules/webm/doc_classes/VideoStreamWebm.xml b/modules/webm/doc_classes/VideoStreamWebm.xml index 8b6696cfe98..6e8120b1deb 100644 --- a/modules/webm/doc_classes/VideoStreamWebm.xml +++ b/modules/webm/doc_classes/VideoStreamWebm.xml @@ -9,11 +9,21 @@ + + + + + + + + + + + + + + - - - -