From 542489a86696cba222711a20e31704a62d4b8fed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Thu, 27 Jun 2019 16:10:09 +0200 Subject: [PATCH] DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`. --- doc/classes/AnimationNodeTransition.xml | 36 ++++++++ doc/classes/AudioEffectChorus.xml | 108 ++++++++++++++++++++++++ doc/classes/CPUParticles.xml | 72 ++++++++++++++++ doc/classes/CPUParticles2D.xml | 72 ++++++++++++++++ doc/classes/Camera2D.xml | 36 ++++++++ doc/classes/ConeTwistJoint.xml | 18 ++++ doc/classes/Control.xml | 44 ++++++++++ doc/classes/DynamicFont.xml | 18 ++++ doc/classes/Environment.xml | 18 ++++ doc/classes/Generic6DOFJoint.xml | 108 ++++++++++++++++++++++++ doc/classes/GeometryInstance.xml | 18 ++++ doc/classes/HingeJoint.xml | 36 ++++++++ doc/classes/KinematicBody.xml | 18 ++++ doc/classes/Light.xml | 18 ++++ doc/classes/NinePatchRect.xml | 18 ++++ doc/classes/Particles.xml | 18 ++++ doc/classes/ParticlesMaterial.xml | 72 ++++++++++++++++ doc/classes/PinJoint.xml | 18 ++++ doc/classes/RigidBody.xml | 18 ++++ doc/classes/SliderJoint.xml | 18 ++++ doc/classes/SpatialMaterial.xml | 54 ++++++++++++ doc/classes/SpriteBase3D.xml | 18 ++++ doc/classes/StreamTexture.xml | 8 ++ doc/classes/StyleBox.xml | 18 ++++ doc/classes/StyleBoxFlat.xml | 54 ++++++++++++ doc/classes/StyleBoxTexture.xml | 36 ++++++++ doc/classes/TextureProgress.xml | 18 ++++ doc/classes/Viewport.xml | 18 ++++ doc/classes/VisibilityEnabler.xml | 18 ++++ doc/classes/VisibilityEnabler2D.xml | 18 ++++ editor/doc/doc_data.cpp | 25 ++---- 31 files changed, 1050 insertions(+), 17 deletions(-) diff --git a/doc/classes/AnimationNodeTransition.xml b/doc/classes/AnimationNodeTransition.xml index 4d2a11578f..82839b6bab 100644 --- a/doc/classes/AnimationNodeTransition.xml +++ b/doc/classes/AnimationNodeTransition.xml @@ -7,6 +7,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/AudioEffectChorus.xml b/doc/classes/AudioEffectChorus.xml index 13bc6ac097..4da125ba63 100644 --- a/doc/classes/AudioEffectChorus.xml +++ b/doc/classes/AudioEffectChorus.xml @@ -9,6 +9,114 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml index 8152a52c86..12e00be04a 100644 --- a/doc/classes/CPUParticles.xml +++ b/doc/classes/CPUParticles.xml @@ -19,6 +19,38 @@ Sets this node's properties to match a given [Particles] node with an assigned [ParticlesMaterial]. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -26,6 +58,46 @@ Restarts the particle emitter. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 585b8b5f5b..7380014b96 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -20,6 +20,38 @@ Sets this node's properties to match a given [Particles2D] node with an assigned [ParticlesMaterial]. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -27,6 +59,46 @@ Restarts the particle emitter. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index e9a9f22e82..750b6851b6 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -45,6 +45,22 @@ Returns the location of the [Camera2D]'s screen-center, relative to the origin. + + + + + + + + + + + + + + + + @@ -60,6 +76,26 @@ This has no effect if smoothing is disabled. + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/ConeTwistJoint.xml b/doc/classes/ConeTwistJoint.xml index ad9c2b3a35..4c95a4bef9 100644 --- a/doc/classes/ConeTwistJoint.xml +++ b/doc/classes/ConeTwistJoint.xml @@ -11,6 +11,24 @@ + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index d25c2b31ee..8ca0bb0b9b 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -173,6 +173,14 @@ The methods [method can_drop_data] and [method drop_data] must be implemented on controls that want to receive drop data. + + + + + + + + @@ -240,6 +248,14 @@ Returns [member margin_right] and [member margin_bottom]. + + + + + + + + @@ -274,6 +290,14 @@ + + + + + + + + @@ -574,6 +598,16 @@ Sets [member margin_right] and [member margin_bottom] at the same time. + + + + + + + + + + @@ -584,6 +618,16 @@ + + + + + + + + + + diff --git a/doc/classes/DynamicFont.xml b/doc/classes/DynamicFont.xml index b7710068a6..ac707d09bc 100644 --- a/doc/classes/DynamicFont.xml +++ b/doc/classes/DynamicFont.xml @@ -40,6 +40,14 @@ Returns the number of fallback fonts. + + + + + + + + @@ -60,6 +68,16 @@ Sets the fallback font at index [code]idx[/code]. + + + + + + + + + + diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 9df8ae1aa5..613c5b6563 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -15,6 +15,24 @@ https://docs.godotengine.org/en/latest/tutorials/3d/high_dynamic_range.html + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/Generic6DOFJoint.xml b/doc/classes/Generic6DOFJoint.xml index 91a1cb1cd4..bc34f3ac0d 100644 --- a/doc/classes/Generic6DOFJoint.xml +++ b/doc/classes/Generic6DOFJoint.xml @@ -9,6 +9,114 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml index eb1847a055..49c1ce480f 100644 --- a/doc/classes/GeometryInstance.xml +++ b/doc/classes/GeometryInstance.xml @@ -9,6 +9,14 @@ + + + + + + + + @@ -18,6 +26,16 @@ Overrides the bounding box of this node with a custom one. To remove it, set an [AABB] with all fields set to zero. + + + + + + + + + + diff --git a/doc/classes/HingeJoint.xml b/doc/classes/HingeJoint.xml index 0ac67be96c..4582e36da6 100644 --- a/doc/classes/HingeJoint.xml +++ b/doc/classes/HingeJoint.xml @@ -9,6 +9,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index b4e6b0abab..b7c4200b95 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -12,6 +12,14 @@ https://docs.godotengine.org/en/latest/tutorials/physics/kinematic_character_2d.html + + + + + + + + @@ -120,6 +128,16 @@ As long as the [code]snap[/code] vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting[code]snap[/code] to[code](0, 0, 0)[/code] or by using [method move_and_slide] instead. + + + + + + + + + + diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml index 64d8442180..6ef7c2652d 100644 --- a/doc/classes/Light.xml +++ b/doc/classes/Light.xml @@ -10,6 +10,24 @@ https://docs.godotengine.org/en/latest/tutorials/3d/lights_and_shadows.html + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index 0723d50ba1..c50c1b6079 100644 --- a/doc/classes/NinePatchRect.xml +++ b/doc/classes/NinePatchRect.xml @@ -9,6 +9,24 @@ + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/Particles.xml b/doc/classes/Particles.xml index 7ff99ebb73..3b9a0554e8 100644 --- a/doc/classes/Particles.xml +++ b/doc/classes/Particles.xml @@ -18,6 +18,14 @@ Returns the axis-aligned bounding box that contains all the particles that are active in the current frame. + + + + + + + + @@ -25,6 +33,16 @@ Restarts the particle emission, clearing existing particles. + + + + + + + + + + diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index ff8e01c6c9..624a8d4dc5 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -11,6 +11,78 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/PinJoint.xml b/doc/classes/PinJoint.xml index 10ae3d27d9..647a59feef 100644 --- a/doc/classes/PinJoint.xml +++ b/doc/classes/PinJoint.xml @@ -9,6 +9,24 @@ + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index a705789413..07eed6bb34 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -82,6 +82,14 @@ Applies a torque impulse which will be affected by the body mass and shape. This will rotate the body around the [code]impulse[/code] vector passed. + + + + + + + + @@ -90,6 +98,16 @@ [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. + + + + + + + + + + diff --git a/doc/classes/SliderJoint.xml b/doc/classes/SliderJoint.xml index a91f67f107..3f22b5a37c 100644 --- a/doc/classes/SliderJoint.xml +++ b/doc/classes/SliderJoint.xml @@ -9,6 +9,24 @@ + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index 5e18e72f90..f739fed733 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -10,6 +10,60 @@ https://docs.godotengine.org/en/latest/tutorials/3d/spatial_material.html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 9c5ed213a8..5529da909d 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -15,12 +15,30 @@ + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/StreamTexture.xml b/doc/classes/StreamTexture.xml index 20cbadb5f0..9c7adea079 100644 --- a/doc/classes/StreamTexture.xml +++ b/doc/classes/StreamTexture.xml @@ -9,6 +9,14 @@ + + + + + + + + diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml index 6b8f076211..1d873ef0b1 100644 --- a/doc/classes/StyleBox.xml +++ b/doc/classes/StyleBox.xml @@ -31,6 +31,14 @@ + + + + + + + + @@ -55,6 +63,16 @@ Returns the "offset" of a stylebox. This helper function returns a value equivalent to [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code]. + + + + + + + + + + diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index 28f49f831c..05ee79eef2 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -24,12 +24,46 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -38,6 +72,16 @@ + + + + + + + + + + @@ -60,6 +104,16 @@ + + + + + + + + + + diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml index e51120f269..f68d749d3b 100644 --- a/doc/classes/StyleBoxTexture.xml +++ b/doc/classes/StyleBoxTexture.xml @@ -9,6 +9,22 @@ + + + + + + + + + + + + + + + + @@ -31,6 +47,26 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/TextureProgress.xml b/doc/classes/TextureProgress.xml index 409d005067..3900b8bf45 100644 --- a/doc/classes/TextureProgress.xml +++ b/doc/classes/TextureProgress.xml @@ -9,6 +9,24 @@ + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index a9ffd9f66d..a882874638 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -67,6 +67,14 @@ Returns information about the viewport from the rendering pipeline. + + + + + + + + @@ -162,6 +170,16 @@ + + + + + + + + + + diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index 4acb4d87c1..e3c7d05fce 100644 --- a/doc/classes/VisibilityEnabler.xml +++ b/doc/classes/VisibilityEnabler.xml @@ -9,6 +9,24 @@ + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index dbea3f5de8..0f25c00489 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/doc/classes/VisibilityEnabler2D.xml @@ -9,6 +9,24 @@ + + + + + + + + + + + + + + + + + + diff --git a/editor/doc/doc_data.cpp b/editor/doc/doc_data.cpp index 6ee07d3661..a8ba54d4f8 100644 --- a/editor/doc/doc_data.cpp +++ b/editor/doc/doc_data.cpp @@ -323,8 +323,14 @@ void DocData::generate(bool p_basic_types) { if (E->get().name == "" || (E->get().name[0] == '_' && !(E->get().flags & METHOD_FLAG_VIRTUAL))) continue; //hidden, don't count - if (skip_setter_getter_methods && setters_getters.has(E->get().name) && E->get().name.find("/") == -1) - continue; + if (skip_setter_getter_methods && setters_getters.has(E->get().name)) { + // Don't skip parametric setters and getters, i.e. method which require + // one or more parameters to define what property should be set or retrieved. + // E.g. CPUParticles::set_param(Parameter param, float value). + if (E->get().arguments.size() == 0 /* getter */ || (E->get().arguments.size() == 1 && E->get().return_val.type == Variant::NIL /* setter */)) { + continue; + } + } MethodDoc method; @@ -366,21 +372,6 @@ void DocData::generate(bool p_basic_types) { method.arguments.push_back(argument); } - - /* - String hint; - switch(arginfo.hint) { - case PROPERTY_HINT_DIR: hint="A directory."; break; - case PROPERTY_HINT_RANGE: hint="Range - min: "+arginfo.hint_string.get_slice(",",0)+" max: "+arginfo.hint_string.get_slice(",",1)+" step: "+arginfo.hint_string.get_slice(",",2); break; - case PROPERTY_HINT_ENUM: hint="Values: "; for(int j=0;j0) hint+=", "; hint+=arginfo.hint_string.get_slice(",",j)+"="+itos(j); } break; - case PROPERTY_HINT_LENGTH: hint="Length: "+arginfo.hint_string; break; - case PROPERTY_HINT_FLAGS: hint="Values: "; for(int j=0;j0) hint+=", "; hint+=arginfo.hint_string.get_slice(",",j)+"="+itos(1<