Commit graph

2459 commits

Author SHA1 Message Date
clayjohn
31506ebe85 updated description of metallic in SpatialMaterial 2020-02-12 15:05:49 +01:00
Hugo Locurcio
f433c3656b Update EditorSceneImporterAssimp description to reflect current status
(cherry picked from commit 95f6be365a)
2020-02-12 15:05:16 +01:00
Haoyu Qiu
7cfcf1824b Completes doc for ItemList and Tree
(cherry picked from commit 7a41c44be2)
2020-02-12 15:05:02 +01:00
seenloitering
20d0034039 Add documentation for Skeleton2D
Signal bone_setup_changed remains undocumented. I took a quick look at
the cpp code, but its purpose remained unclear to me. If anyone can
steer me in the right direction, I'm happy to flesh this out.

(cherry picked from commit 9151992432)
2020-02-12 15:04:49 +01:00
Rémi Verschelde
4657daff05 doc: Add description for EditorInspector
(cherry-picked from #35858)
2020-02-12 15:04:19 +01:00
Hugo Locurcio
23e08b0fad Improve the doc_status.py console output
- Duplicate the header when the `-a` flag is enabled. Since lots of
  items are displayed in this case, this helps the user remember
  which column is which without having to scroll back to the top.
- Bolden the overall percentages for easier visual grepping.

(cherry picked from commit 7c3f6b2870)
2020-02-12 14:59:21 +01:00
clayjohn
453babc60d Finish documenting BakedLightmap and TextureLayered
(cherry picked from commit 5643bc71f7)
2020-02-06 13:02:08 +01:00
Haoyu Qiu
11f012d2db Completes doc for button classes
(cherry picked from commit db42d5ddff)
2020-02-06 13:02:08 +01:00
Hugo Locurcio
47368f2b7c doc: Add an example for Array.sort()
This may help people understand the difference between alphabetical
and natural order more quickly.

(cherry picked from commit 1de9118c5f)
2020-02-06 13:02:08 +01:00
Hugo Locurcio
3410dd3a9e doc: Add a short AnimationPlayer versus Tween comparison
Many newcomers are confused about which one to choose for animating
properties. This should help clarify the situation with regards
to AnimationPlayer versus Tween.

(cherry picked from commit 810b1341ce)
2020-02-06 13:02:08 +01:00
Hugo Locurcio
cbd4784d14 Improve the CheckBox and CheckButton class documentations
This makes the CheckBox and CheckButton classes 100% documented.

(cherry picked from commit c9946bc87e)
2020-02-06 13:02:08 +01:00
Rémi Verschelde
68eae6b6e9 Fix some URLs to use HTTPS when available 2020-01-29 02:48:10 +01:00
Hugo Locurcio
8ea77b96b2
Mention 2D polygon limits and how to increase them in the documentation
This closes #21793.
2020-01-28 22:04:29 +01:00
Rémi Verschelde
658e44ee01 doc: Sync classref with current source
Fix a few typos.
2020-01-28 10:58:48 +01:00
Yuri Roubinsky
766d1ef276 Docs for some nodes in visual shader(part 2) 2020-01-28 12:16:09 +03:00
Yuri Roubinsky
9705d5587e Hide "control" methods from VisualShaderNodeGroupBase 2020-01-28 10:24:59 +03:00
Yuri Roubinsky
274f1d8610 Hide "editable" property from VisualShaderNodeGroupBase public interface 2020-01-28 09:43:07 +03:00
Yuri Roubinsky
796484d761 Added missing property "size" to VisualShaderNodeGroupBase 2020-01-27 19:18:48 +03:00
Yuri Roubinsky
3479cf4b42 Removed unused method "build" from VisualShaderNodeExpression 2020-01-27 18:24:39 +03:00
Tomasz Chabora
21dd35b611 Document theme_items of multiple classes 2020-01-27 02:15:37 +01:00
Hugo Locurcio
75185f87a3
doc: Remove mention of nonexistent StaticBody simulated motion mode
The StaticBody2D documentation doesn't mention it, so it doesn't need
to be touched.

This closes #30560.
2020-01-26 20:18:22 +01:00
Rémi Verschelde
4cee1cda5e
Merge pull request #35589 from akien-mga/doc-drop-category-property
doc: Drop unused 'category' property from header
2020-01-26 16:34:13 +01:00
Rémi Verschelde
09ced94dd4 doc: Do not expose Variant::NIL as a type in the class reference
Fix signals Variant arguments incorrectly listed as Nil.

Fixes #12520.
2020-01-26 16:08:11 +01:00
Rémi Verschelde
2d20fc39aa doc: Drop unused 'category' property from header
We already removed it from the online docs with #35132.

Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.

We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
2020-01-26 16:02:39 +01:00
Rémi Verschelde
3697ea799c doc: Document all remaining ProjectSettings 2020-01-26 13:37:21 +01:00
Rémi Verschelde
fe26e53065
Merge pull request #35581 from akien-mga/doc-color-constants
doc: Document named color constants
2020-01-26 13:36:44 +01:00
Rémi Verschelde
cbdbfb00ca doc: Document named color constants
Busywork but it's good for our completion rate :)
2020-01-26 12:08:16 +01:00
Rémi Verschelde
bb6c0d3e8b doc: Complete documentation for VideoStreams
Also quick clean up of the matching C++ files.
2020-01-26 11:29:07 +01:00
Rémi Verschelde
bd605a5701
Merge pull request #35566 from Xrayez/doc-parse-property-return
Document the return value of `EditorInspectorPlugin.parse_property`
2020-01-26 10:17:57 +01:00
Rémi Verschelde
6a5c8c8672
Merge pull request #35574 from clayjohn/DOCS-odds-n-ends
Complete various class references
2020-01-26 10:08:55 +01:00
clayjohn
c5700f7464 Complete various class references 2020-01-26 00:27:51 -08:00
Rémi Verschelde
1b3eb41622
Merge pull request #35561 from clayjohn/GLES3-irradiance-max
Add project setting for max irradiance size
2020-01-26 09:16:21 +01:00
Andrii Doroshenko (Xrayez)
06933f5d80 Document the return value of EditorInspectorPlugin.parse_property 2020-01-26 02:04:33 +02:00
Rémi Verschelde
be1bc53d42
Merge pull request #35560 from clayjohn/DOCS-sky-radiance
Add warning for radiance_size
2020-01-25 23:01:58 +01:00
clayjohn
7215019020 Add warning for radiance_size 2020-01-25 13:28:32 -08:00
clayjohn
eb5cb5d016 Add project setting for max irradiance size 2020-01-25 13:27:13 -08:00
Rémi Verschelde
8896ce1c0a
Merge pull request #35559 from Calinou/doc-inputeventkey-string
Document how to get a human-readable string from an InputEventKey
2020-01-25 21:52:35 +01:00
Hugo Locurcio
7a0c37c3f5
Document how to get a human-readable string from an InputEventKey 2020-01-25 20:13:18 +01:00
Hugo Locurcio
33f37cfd19
Document how to get chamfered corners with StyleBoxFlat 2020-01-25 20:04:23 +01:00
Rémi Verschelde
a61f5a7520
Merge pull request #35535 from Calinou/doc-projectsettings-runtime-physics
Document how to change the default gravity at runtime
2020-01-25 18:16:34 +01:00
Hugo Locurcio
1b9b07e658
Document how to change the default gravity at runtime
Changing the default gravity at runtime isn't exactly obvious,
so it makes sense to add a code sample.
2020-01-25 16:28:28 +01:00
Rémi Verschelde
e61edd69ea
Merge pull request #35523 from searetseltev/master
Update ScrollContainer.xml
2020-01-24 21:53:57 +01:00
Roi Valcárcel
4f0401d05d Update ScrollContainer.xml
Add missing descriptions to ScrollContainer documentation
2020-01-24 17:21:53 +01:00
Tomasz Chabora
25ea912d96 Count theme items in doc_status.py 2020-01-24 14:23:58 +01:00
Rémi Verschelde
97cc2e53f6 makerst: Escape reST markup after enums
Fixes #35501.
2020-01-24 13:08:36 +01:00
Yuri Roubinsky
ce43c92208 Docs for some nodes in visual shader
Fix typo in `VisualShaderNodeCompare.ComparisonType` name.
2020-01-23 22:39:00 +01:00
Rémi Verschelde
c66144738b
Merge pull request #35483 from YeldhamDev/doc_comment_spaces_removal
Remove unnecessary extra spaces before comments in code examples.
2020-01-23 21:58:12 +01:00
Michael Alexsander
c4745c96d7 Remove unnecessary extra spaces before comments in code examples. 2020-01-23 14:41:49 -03:00
Michael Alexsander
e1a9a3328d Remove unnecessary parenthesis from code examples 2020-01-23 14:15:39 -03:00
clayjohn
6b66957b85 Finish documenting CSG* and *probes 2020-01-23 13:54:17 +01:00